From 0b4f4aff308792890dd6e196e57c5ab581148330 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Fri, 19 May 2023 10:16:44 -0700 Subject: [PATCH] feat(all): auto-regenerate discovery clients (#1988) --- api-list.json | 30 - chat/v1/chat-api.json | 300 +-- chat/v1/chat-gen.go | 714 +++---- cloudfunctions/v1/cloudfunctions-api.json | 74 +- cloudfunctions/v1/cloudfunctions-gen.go | 102 + cloudfunctions/v2/cloudfunctions-api.json | 74 +- cloudfunctions/v2/cloudfunctions-gen.go | 102 + .../v2alpha/cloudfunctions-api.json | 74 +- cloudfunctions/v2alpha/cloudfunctions-gen.go | 102 + cloudfunctions/v2beta/cloudfunctions-api.json | 74 +- cloudfunctions/v2beta/cloudfunctions-gen.go | 102 + cloudsearch/v1/cloudsearch-api.json | 413 +++- cloudsearch/v1/cloudsearch-gen.go | 624 +++++- cloudtrace/v2/cloudtrace-api.json | 4 +- cloudtrace/v2/cloudtrace-gen.go | 4 +- dlp/v2/dlp-api.json | 24 +- dlp/v2/dlp-gen.go | 42 +- drive/v3/drive-api.json | 915 +++++---- drive/v3/drive-gen.go | 1766 +++++++++-------- .../v1/paymentsresellersubscription-api.json | 4 +- .../v1/paymentsresellersubscription-gen.go | 3 +- retail/v2/retail-api.json | 6 +- retail/v2/retail-gen.go | 10 +- retail/v2alpha/retail-api.json | 6 +- retail/v2alpha/retail-gen.go | 10 +- retail/v2beta/retail-api.json | 6 +- retail/v2beta/retail-gen.go | 10 +- 27 files changed, 3658 insertions(+), 1937 deletions(-) diff --git a/api-list.json b/api-list.json index 8e07ec3de5c..2b2064b3336 100644 --- a/api-list.json +++ b/api-list.json @@ -47,36 +47,6 @@ "documentationLink": "https://cloud.google.com/assured-workloads/access-approval/docs", "preferred": true }, - { - "kind": "discovery#directoryItem", - "id": "accesscontextmanager:v1beta", - "name": "accesscontextmanager", - "version": "v1beta", - "title": "Access Context Manager API", - "description": "An API for setting attribute based access control to requests to Google Cloud services.", - "discoveryRestUrl": "https://accesscontextmanager.googleapis.com/$discovery/rest?version=v1beta", - "icons": { - "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", - "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" - }, - "documentationLink": "https://cloud.google.com/access-context-manager/docs/reference/rest/", - "preferred": false - }, - { - "kind": "discovery#directoryItem", - "id": "accesscontextmanager:v1", - "name": "accesscontextmanager", - "version": "v1", - "title": "Access Context Manager API", - "description": "An API for setting attribute based access control to requests to Google Cloud services.", - "discoveryRestUrl": "https://accesscontextmanager.googleapis.com/$discovery/rest?version=v1", - "icons": { - "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", - "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" - }, - "documentationLink": "https://cloud.google.com/access-context-manager/docs/reference/rest/", - "preferred": true - }, { "kind": "discovery#directoryItem", "id": "acmedns:v1", diff --git a/chat/v1/chat-api.json b/chat/v1/chat-api.json index 10907505e00..fbb26790948 100644 --- a/chat/v1/chat-api.json +++ b/chat/v1/chat-api.json @@ -225,7 +225,7 @@ "spaces": { "methods": { "create": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a named space. Spaces grouped by topics or that have guest access are not supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.", + "description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a named space. Spaces grouped by topics or that have guest access aren't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.", "flatPath": "v1/spaces", "httpMethod": "POST", "id": "chat.spaces.create", @@ -250,7 +250,7 @@ ] }, "delete": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): 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. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who has permission to delete the space, and the `chat.delete` scope.", + "description": "[Developer Preview](https://developers.google.com/workspace/preview): 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. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who has permission to delete the space, and the `chat.delete` scope.", "flatPath": "v1/spaces/{spacesId}", "httpMethod": "DELETE", "id": "chat.spaces.delete", @@ -259,7 +259,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the space to delete. Format: spaces/{space}", + "description": "Required. Resource name of the space to delete. Format: `spaces/{space}`", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -282,7 +282,7 @@ "parameterOrder": [], "parameters": { "name": { - "description": "Required. Resource name of the user to find direct message with. Format: users/{user}, where `{user}` is either the `{person_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 Admin SDK Directory API. For example, if the People API `Person.resourceName` is `people/123456789`, you can find a direct message with that person by using `users/123456789` as the `name`.", + "description": "Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `{person_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 `Person.resourceName` is `people/123456789`, you can find a direct message with that person by using `users/123456789` as the `name`.", "location": "query", "type": "string" } @@ -307,7 +307,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the space, in the form \"spaces/*\". Format: spaces/{space}", + "description": "Required. Resource name of the space, in the form \"spaces/*\". Format: `spaces/{space}`", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -332,18 +332,18 @@ "parameterOrder": [], "parameters": { "filter": { - "description": "Optional. A query filter. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). You can filter spaces by the space type ([`space_type`](https://developers.google.com/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` cannot 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. With [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), this field is ignored and the query always returns all spaces. But Chat API still validates the query syntax with service accounts, so invalid queries are still rejected. [Developer Preview](https://developers.google.com/workspace/preview).", + "description": "Optional. A query filter. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). You can filter spaces by the space type ([`space_type`](https://developers.google.com/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. With [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), this field is ignored and the query always returns all spaces. But the Chat API still validates the query syntax with service accounts, so invalid queries are still rejected. [Developer Preview](https://developers.google.com/workspace/preview).", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. 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; values above 1000 are coerced to 1000. Negative values return an `INVALID_ARGUMENT` error.", + "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 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A page token, received from a previous list spaces 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 may lead to unexpected results.", + "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.", "location": "query", "type": "string" } @@ -368,14 +368,14 @@ ], "parameters": { "name": { - "description": "Resource name of the space. Format: spaces/{space}", + "description": "Resource name of the space. Format: `spaces/{space}`", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. The field paths to be updated, comma separated if there are multiple. Currently supported field paths: - display_name (Only supports changing the display name of a space with the SPACE type, or when also including the `space_type` mask to change a GROUP_CHAT space type to SPACE. Trying to update the display name of a GROUP_CHAT or a DIRECT_MESSAGE space results in an invalid argument error.) - 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_details - space_history_state (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.)", + "description": "Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument error.) - `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_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.)", "format": "google-fieldmask", "location": "query", "type": "string" @@ -393,7 +393,7 @@ ] }, "setup": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): 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. To specify the human members to add, add memberships with the appropriate `member.name` in the `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` is either the `{person_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 Admin SDK Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`, you can add the user to the space by including a membership with `users/123456789` as the `member.name`. For a space or group chat, if the caller blocks or is blocked by 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 add app memberships to DMs. To add the calling app as a member of other space types, use [create membership](https://developers.google.com/chat/api/reference/rest/v1/spaces.members/create) 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 or guest access are not supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.", + "description": "[Developer Preview](https://developers.google.com/workspace/preview): 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. To specify the human members to add, add memberships with the appropriate `member.name` in the `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` is either the `{person_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 Admin SDK Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`, you can add the user to the space by including a membership with `users/123456789` as the `member.name`. For a space or group chat, if the caller blocks or is blocked by 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 add app memberships to DMs. To add the calling app as a member of other space types, use [create membership](https://developers.google.com/chat/api/reference/rest/v1/spaces.members/create) 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 or guest access aren't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.", "flatPath": "v1/spaces:setup", "httpMethod": "POST", "id": "chat.spaces.setup", @@ -416,7 +416,7 @@ "members": { "methods": { "create": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a human membership or app membership for the calling app. Creating memberships for other apps is not supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.memberships` (for human membership) or `chat.memberships.app` (for app membership) scope. To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to the space, use `users/app`. - To add a human user, use `users/{user}`, where `{user}` is either the `{person_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 Admin SDK Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`, the user can be added to the space by setting the `membership.member.name` to `users/123456789`.", + "description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.memberships` (for human membership) or `chat.memberships.app` (for app membership) scope. To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to the space, use `users/app`. - To add a human user, use `users/{user}`, where `{user}` is either the `{person_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 `Person` `resourceName` is `people/123456789`, you can add the user to the space by setting the `membership.member.name` to `users/123456789`.", "flatPath": "v1/spaces/{spacesId}/members", "httpMethod": "POST", "id": "chat.spaces.members.create", @@ -454,7 +454,7 @@ ], "parameters": { "name": { - "description": "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 and `spaces/{space}/members/{member}` format. 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", + "description": "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 and `spaces/{space}/members/{member}` format. 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`", "location": "path", "pattern": "^spaces/[^/]+/members/[^/]+$", "required": true, @@ -480,7 +480,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the membership to retrieve. Format: spaces/{space}/members/{member}", + "description": "Required. Resource name of the membership to retrieve. Format: `spaces/{space}/members/{member}`", "location": "path", "pattern": "^spaces/[^/]+/members/[^/]+$", "required": true, @@ -512,13 +512,13 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of memberships to return. The service may return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000; values above 1000 are coerced to 1000. Negative values return an INVALID_ARGUMENT error.", + "description": "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 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous call to list memberships. 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 may lead to unexpected results.", + "description": "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.", "location": "query", "type": "string" }, @@ -572,14 +572,14 @@ ], "enumDescriptions": [ "Default. Starts a thread.", - "Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, the message starts a new thread instead.", - "Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, a NOT_FOUND error is returned instead." + "Creates the message as a reply to the thread specified by thread ID or `thread_key`. If it fails, the message starts a new thread instead.", + "Creates the message as a reply to the thread specified by thread ID or `thread_key`. If it fails, a `NOT_FOUND` error is returned instead." ], "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the space in which to create a message. Format: spaces/{space}", + "description": "Required. The resource name of the space in which to create a message. Format: `spaces/{space}`", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -624,7 +624,7 @@ "type": "boolean" }, "name": { - "description": "Required. Resource name of the message to be deleted, in the form \"spaces/*/messages/*\" Example: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB", + "description": "Required. Resource name of the message that you want to delete, in the form `spaces/*/messages/*` Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`", "location": "path", "pattern": "^spaces/[^/]+/messages/[^/]+$", "required": true, @@ -650,7 +650,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the message to retrieve. Format: spaces/{space}/messages/{message} If the message begins with `client-`, then it has a custom name assigned by a Chat app that created it with the Chat REST API. That Chat app (but not others) can pass the custom name to get, update, or delete the message. To learn more, see [create and name a message] (https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).", + "description": "Required. Resource name of the message to retrieve. Format: `spaces/{space}/messages/{message}` If the message begins with `client-`, then it has a custom name assigned by a Chat app that created it with the Chat REST API. That Chat app (but not others) can pass the custom name to get, update, or delete the message. To learn more, see [create and name a message] (https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).", "location": "path", "pattern": "^spaces/[^/]+/messages/[^/]+$", "required": true, @@ -682,23 +682,23 @@ "type": "string" }, "orderBy": { - "description": "Optional, if resuming from a previous query. How the list of messages is ordered. Specify a value to order by and an ordering operation. Valid ordering operation values are: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.", + "description": "Optional, if resuming from a previous query. 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`.", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of messages returned. The service may return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000; values above 1000 are coerced to 1000. Negative values return an `INVALID_ARGUMENT` error.", + "description": "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 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional, if resuming from a previous query. A page token received from a previous list messages 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 may lead to unexpected results.", + "description": "Optional, if resuming from a previous query. 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.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the space to list messages from. Format: spaces/{space}", + "description": "Required. The resource name of the space to list messages from. Format: `spaces/{space}`", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -729,7 +729,7 @@ ], "parameters": { "allowMissing": { - "description": "Optional. If `true` and the message is not found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.", + "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/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.", "location": "query", "type": "boolean" }, @@ -741,7 +741,7 @@ "type": "string" }, "updateMask": { - "description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - cards_v2 ", + "description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` ", "format": "google-fieldmask", "location": "query", "type": "string" @@ -769,7 +769,7 @@ ], "parameters": { "allowMissing": { - "description": "Optional. If `true` and the message is not found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.", + "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/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.", "location": "query", "type": "boolean" }, @@ -781,7 +781,7 @@ "type": "string" }, "updateMask": { - "description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - cards_v2 ", + "description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` ", "format": "google-fieldmask", "location": "query", "type": "string" @@ -813,7 +813,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the attachment, in the form \"spaces/*/messages/*/attachments/*\".", + "description": "Required. Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.", "location": "path", "pattern": "^spaces/[^/]+/messages/[^/]+/attachments/[^/]+$", "required": true, @@ -842,7 +842,7 @@ ], "parameters": { "parent": { - "description": "Required. The message where the reaction is created. Format: spaces/{space}/messages/{message}", + "description": "Required. The message where the reaction is created. Format: `spaces/{space}/messages/{message}`", "location": "path", "pattern": "^spaces/[^/]+/messages/[^/]+$", "required": true, @@ -872,7 +872,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the reaction to delete. Format: spaces/{space}/messages/{message}/reactions/{reaction}", + "description": "Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`", "location": "path", "pattern": "^spaces/[^/]+/messages/[^/]+/reactions/[^/]+$", "required": true, @@ -903,18 +903,18 @@ "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of reactions returned. The service may 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.", + "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", "location": "query", "type": "integer" }, "pageToken": { - "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 may lead to unexpected results.", + "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.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The message users reacted to. Format: spaces/{space}/messages/{message}", + "description": "Required. The message users reacted to. Format: `spaces/{space}/messages/{message}`", "location": "path", "pattern": "^spaces/[^/]+/messages/[^/]+$", "required": true, @@ -939,11 +939,11 @@ } } }, - "revision": "20230514", + "revision": "20230516", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { - "description": "List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze 1 day, snooze next week. You might use action method = snooze(), passing the snooze type and snooze time in the list of string parameters.", + "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.", "id": "ActionParameter", "properties": { "key": { @@ -976,17 +976,17 @@ "DIALOG" ], "enumDescriptions": [ - "Default type; will be handled as NEW_MESSAGE.", + "Default type that's handled as `NEW_MESSAGE`.", "Post as a new message in the topic.", - "Update the Chat app's message. This is only permitted on a CARD_CLICKED event where the message sender type is BOT.", - "Update the cards on a user's message. This is only permitted as a response to a MESSAGE event with a matched url, or a CARD_CLICKED event where the message sender type is HUMAN. Text will be ignored.", - "Privately ask the user for additional auth or config.", + "Update the Chat app's message. This is only permitted on a `CARD_CLICKED` event where the message sender type is `BOT`.", + "Update the cards on a user's message. This is only permitted as a response to a `MESSAGE` event with a matched url, or a `CARD_CLICKED` event where the message sender type is `HUMAN`. Text is ignored.", + "Privately ask the user for additional authentication or configuration.", "Presents a [dialog](https://developers.google.com/chat/how-tos/dialogs)." ], "type": "string" }, "url": { - "description": "Input only. URL for users to auth or config. (Only for REQUEST_CONFIG response types.)", + "description": "Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)", "type": "string" } }, @@ -1071,7 +1071,7 @@ "SLASH_COMMAND" ], "enumDescriptions": [ - "Default value for the enum. DO NOT USE.", + "Default value for the enum. Don't use.", "A user is mentioned.", "A slash command is invoked." ], @@ -1090,7 +1090,7 @@ "properties": { "attachmentDataRef": { "$ref": "AttachmentDataRef", - "description": "A reference to the attachment data. This is used with the media API to download the attachment data." + "description": "A reference to the attachment data. This field is used with the media API to download the attachment data." }, "contentName": { "description": "The original file name for the content, not the full path.", @@ -1101,16 +1101,16 @@ "type": "string" }, "downloadUri": { - "description": "Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps should not use this URL to download attachment content.", + "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": "DriveDataRef", - "description": "A reference to the drive attachment. This is used with the Drive API." + "description": "A reference to the drive attachment. This field is used with the Drive API." }, "name": { - "description": "Resource name of the attachment, in the form \"spaces/*/messages/*/attachments/*\".", + "description": "Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.", "type": "string" }, "source": { @@ -1128,7 +1128,7 @@ "type": "string" }, "thumbnailUri": { - "description": "Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps should not use this URL to download attachment content.", + "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" } @@ -1143,7 +1143,7 @@ "type": "string" }, "resourceName": { - "description": "The resource name of the attachment data. This is used with the media API to download the attachment data.", + "description": "The resource name of the attachment data. This field is used with the media API to download the attachment data.", "type": "string" } }, @@ -1155,17 +1155,17 @@ "properties": { "imageButton": { "$ref": "ImageButton", - "description": "A button with image and onclick action." + "description": "A button with image and `onclick` action." }, "textButton": { "$ref": "TextButton", - "description": "A button with text and onclick action." + "description": "A button with text and `onclick` action." } }, "type": "object" }, "Card": { - "description": "A card is a UI element that can contain UI widgets such as texts, images.", + "description": "A card is a UI element that can contain UI widgets such as text and images.", "id": "Card", "properties": { "cardActions": { @@ -1212,7 +1212,7 @@ "id": "CardHeader", "properties": { "imageStyle": { - "description": "The image's type (e.g. square border or circular border).", + "description": "The image's type (for example, square border or circular border).", "enum": [ "IMAGE_STYLE_UNSPECIFIED", "IMAGE", @@ -1234,7 +1234,7 @@ "type": "string" }, "title": { - "description": "The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each will take up 1 line. If only the title is specified, it will take up both lines.", + "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" } }, @@ -1275,7 +1275,7 @@ "type": "object" }, "Color": { - "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/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 carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). 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:\u0026red green:\u0026green blue:\u0026blue alpha:\u0026alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha \u003c= 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 \u003c\u003c 16) | (green \u003c\u003c 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i \u003c missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", + "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 does not 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:\u0026red green:\u0026green blue:\u0026blue alpha:\u0026alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha \u003c= 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 \u003c\u003c 16) | (green \u003c\u003c 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i \u003c missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", "id": "Color", "properties": { "alpha": { @@ -1540,7 +1540,7 @@ "properties": { "body": { "$ref": "GoogleAppsCardV1Card", - "description": "Input only. Body of the dialog, which is rendered in a modal. Google Chat apps do not support the following card entities: `DateTimePicker`, `OnChangeAction`." + "description": "Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`." } }, "type": "object" @@ -1565,7 +1565,7 @@ "id": "DriveDataRef", "properties": { "driveFileId": { - "description": "The id for the drive file, for use with the Drive API.", + "description": "The ID for the drive file. Use with the Drive API.", "type": "string" } }, @@ -1610,11 +1610,11 @@ "type": "object" }, "FormAction": { - "description": "A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form.", + "description": "A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.", "id": "FormAction", "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. The same method name can be used for several elements that trigger a common behavior if desired.", + "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": { @@ -1628,7 +1628,7 @@ "type": "object" }, "GoogleAppsCardV1Action": { - "description": "An action that describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. If the action is triggered, the form values are sent to the server.", + "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.", "id": "GoogleAppsCardV1Action", "properties": { "function": { @@ -1636,7 +1636,7 @@ "type": "string" }, "interaction": { - "description": "Optional. Required when opening a [dialog](https://developers.google.com/chat/how-tos/dialogs). What to do in response to an interaction with a user, such as a user clicking button on 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/chat/how-tos/dialogs). When specified, a loading indicator is not shown. Supported by Chat apps, but not Google Workspace Add-ons. If specified for an add-on, the entire card is stripped and nothing is shown in the client.", + "description": "Optional. Required when opening a [dialog](https://developers.google.com/chat/how-tos/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/chat/how-tos/dialogs). When specified, a loading indicator isn't shown. Supported by Chat apps, but not Google Workspace Add-ons. If specified for an add-on, the entire card is stripped and nothing is shown in the client.", "enum": [ "INTERACTION_UNSPECIFIED", "OPEN_DIALOG" @@ -1667,14 +1667,14 @@ "type": "array" }, "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/chat/api/guides/message-formats/cards) in Chat apps, you must also set the action's [ResponseType](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/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`.", + "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/chat/api/guides/message-formats/cards) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/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" } }, "type": "object" }, "GoogleAppsCardV1ActionParameter": { - "description": "List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze 1 day, 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/chat/api/reference/rest/v1/Event#commoneventobject).", + "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/chat/api/reference/rest/v1/Event#commoneventobject).", "id": "GoogleAppsCardV1ActionParameter", "properties": { "key": { @@ -1719,16 +1719,16 @@ "type": "object" }, "GoogleAppsCardV1Button": { - "description": "A text, icon, or text + icon button that users can click. To make an image a clickable button, specify an Image (not an ImageComponent) and set an `onClick` action.", + "description": "A text, icon, or text and icon button that users can click. To make an image a clickable button, specify an `Image` (not an `ImageComponent`) and set an `onClick` action.", "id": "GoogleAppsCardV1Button", "properties": { "altText": { - "description": "The alternative text 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/chat\".", + "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/chat\".", "type": "string" }, "color": { "$ref": "Color", - "description": "If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background will likely result in white text. If unset, the image background is white and the font color is blue. For red, green and blue, the value of each field is a `float` number that can be expressed in either of two ways: as a number between 0 and 255 divided by 255 (153/255) or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 represent the full presence of that color on the RGB scale. Optionally set alpha, which sets a level of transparency using this equation: ``` pixel color = alpha * (this color) + (1.0 - alpha) * (background color) ``` For alpha, a value of 1 corresponds with a solid color, and a value of 0 corresponds with a completely transparent color. For example, the following color represents a half transparent red: ``` \"color\": { \"red\": 1, \"green\": 0, \"blue\": 0, \"alpha\": 0.5 } ```" + "description": "If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background likely results in white text. If unset, the image background is white and the font color is blue. For red, green, and blue, the value of each field is a `float` number that you can express in either of two ways: as a number between 0 and 255 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 represent the full presence of that color on the RGB scale. Optionally set `alpha`, which sets a level of transparency using this equation: ``` pixel color = alpha * (this color) + (1.0 - alpha) * (background color) ``` For `alpha`, a value of `1` corresponds with a solid color, and a value of `0` corresponds with a completely transparent color. For example, the following color represents a half transparent red: ``` \"color\": { \"red\": 1, \"green\": 0, \"blue\": 0, \"alpha\": 0.5 } ```" }, "disabled": { "description": "If `true`, the button is displayed in an inactive state and doesn't respond to user actions.", @@ -1740,7 +1740,7 @@ }, "onClick": { "$ref": "GoogleAppsCardV1OnClick", - "description": "Required. The action to perform when the button is clicked, such as opening a hyperlink or running a custom function." + "description": "Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function." }, "text": { "description": "The text displayed inside the button.", @@ -1764,11 +1764,11 @@ "type": "object" }, "GoogleAppsCardV1Card": { - "description": "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. In Google Chat, cards appear in several places: - As stand-alone messages. - Accompanying a text message, just beneath the text message. - As a [dialog](https://developers.google.com/chat/how-tos/dialogs). The following example JSON creates a \"contact card\" that features: - A header with the contact's name, job title, avatar picture. - A section with the contact information, including formatted text. - Buttons that users can click to share the contact or see more or less info. ![Example contact card](https://developers.google.com/chat/images/card_api_reference.png) ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/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\", } ], } } }, ], } }, ], }, ], }, } ], } ```", + "description": "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. In Google Chat, cards appear in several places: - As stand-alone messages. - Accompanying a text message, just beneath the text message. - As a [dialog](https://developers.google.com/chat/how-tos/dialogs). The following example JSON creates a \"contact card\" that features: - A header with the contact's name, job title, and avatar picture. - A section with the contact information, including formatted text. - Buttons that users can click to share the contact, or see more or less information. ![Example contact card](https://developers.google.com/chat/images/card_api_reference.png) ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/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\", } ], } } }, ], } }, ], }, ], }, } ], } ```", "id": "GoogleAppsCardV1Card", "properties": { "cardActions": { - "description": "The card's actions. Actions are added to the card's toolbar menu. Because Chat app cards have no toolbar, `cardActions[]` is not supported by Chat apps. 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\" } } } ] ```", + "description": "The card's actions. Actions are added to the card's toolbar menu. Because Chat app cards have no toolbar, `cardActions[]` isn't supported by Chat apps. 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\" } } } ] ```", "items": { "$ref": "GoogleAppsCardV1CardAction" }, @@ -1782,7 +1782,7 @@ "REPLACE" ], "enumDescriptions": [ - "Do not use.", + "Don't use.", "The header of the card appears at the bottom of the sidebar, partially covering the current top card of the stack. Clicking the header pops the card into the card stack. If the card has no header, a generated header is used instead.", "Default value. The card is shown by replacing the view of the top card in the card stack." ], @@ -1839,7 +1839,7 @@ }, "secondaryButton": { "$ref": "GoogleAppsCardV1Button", - "description": "The secondary button of the fixed footer. The button must be a text button with text and color set. `primaryButton` must be set if `secondaryButton` is set." + "description": "The secondary button of the fixed footer. The button must be a text button with text and color set. If `secondaryButton` is set, you must also set `primaryButton`." }, "widgets": { "description": "A list of widgets included in the card footer. Primary button and secondary button are rendered below these widgets.", @@ -1856,7 +1856,7 @@ "id": "GoogleAppsCardV1CardHeader", "properties": { "imageAltText": { - "description": "The alternative text of this image which is used for accessibility.", + "description": "The alternative text of this image that's used for accessibility.", "type": "string" }, "imageType": { @@ -1929,7 +1929,7 @@ "BOTTOM" ], "enumDescriptions": [ - "Unspecified. Do not use.", + "Unspecified. Don't use.", "Default value. Aligns widgets to the center of a column.", "Aligns widgets to the top of a column.", "Aligns widgets to the bottom of a column." @@ -2004,7 +2004,7 @@ "type": "object" }, "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.", + "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.", "id": "GoogleAppsCardV1DecoratedText", "properties": { "bottomLabel": { @@ -2013,7 +2013,7 @@ }, "button": { "$ref": "GoogleAppsCardV1Button", - "description": "A button that can be clicked to trigger an action." + "description": "A button that a user can click to trigger an action." }, "endIcon": { "$ref": "GoogleAppsCardV1Icon", @@ -2025,7 +2025,7 @@ }, "onClick": { "$ref": "GoogleAppsCardV1OnClick", - "description": "When users click on `topLabel` or `bottomLabel`, this action triggers." + "description": "This action is triggered when users click `topLabel` or `bottomLabel`." }, "startIcon": { "$ref": "GoogleAppsCardV1Icon", @@ -2033,10 +2033,10 @@ }, "switchControl": { "$ref": "GoogleAppsCardV1SwitchControl", - "description": "A switch widget can be clicked to change its state and trigger an action." + "description": "A switch widget that a user can click to change its state and trigger an action." }, "text": { - "description": "Required. The primary text. Supports simple formatting. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.", + "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/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "topLabel": { @@ -2051,7 +2051,7 @@ "type": "object" }, "GoogleAppsCardV1Divider": { - "description": "Displays a divider between widgets, a horizontal line. For example, the following JSON creates a divider: ``` \"divider\": {} ```", + "description": "Displays a divider between widgets as a horizontal line. For example, the following JSON creates a divider: ``` \"divider\": {} ```", "id": "GoogleAppsCardV1Divider", "properties": {}, "type": "object" @@ -2119,7 +2119,7 @@ "id": "GoogleAppsCardV1GridItem", "properties": { "id": { - "description": "A user-specified identifier for this grid item. This identifier is returned in the parent Grid's onClick callback parameters.", + "description": "A user-specified identifier for this grid item. This identifier is returned in the parent grid's `onClick` callback parameters.", "type": "string" }, "image": { @@ -2156,7 +2156,7 @@ "id": "GoogleAppsCardV1Icon", "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/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.", + "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/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": { @@ -2187,16 +2187,16 @@ "id": "GoogleAppsCardV1Image", "properties": { "altText": { - "description": "The alternative text of this image, used for accessibility.", + "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/chat/images/quickstart-app-avatar.png ```", + "description": "The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/chat/images/quickstart-app-avatar.png ```", "type": "string" }, "onClick": { "$ref": "GoogleAppsCardV1OnClick", - "description": "When a user clicks on the image, the click triggers this action." + "description": "When a user clicks the image, the click triggers this action." } }, "type": "object" @@ -2225,11 +2225,11 @@ "type": "object" }, "GoogleAppsCardV1ImageCropStyle": { - "description": "Represents the crop style applied to an image. For example, here's how to apply a 16 by 9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```", + "description": "Represents the crop style applied to an image. For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```", "id": "GoogleAppsCardV1ImageCropStyle", "properties": { "aspectRatio": { - "description": "The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example, here's how to apply a 16 by 9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```", + "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" }, @@ -2243,7 +2243,7 @@ "RECTANGLE_4_3" ], "enumDescriptions": [ - "No value specified. Do not use.", + "No value specified. Don't use.", "Default value. Applies a square crop.", "Applies a circular crop.", "Applies a rectangular crop with a custom aspect ratio. Set the custom aspect ratio with `aspectRatio`.", @@ -2288,8 +2288,8 @@ "RELOAD" ], "enumDescriptions": [ - "Default value. The card does not reload; nothing happens.", - "Reloads the card after the child window closes. If used in conjunction with [OpenAs.OVERLAY](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#openas), the child window acts as a modal dialog and the parent card is blocked until the child window closes." + "Default value. The card doesn't reload; nothing happens.", + "Reloads the card after the child window closes. If used in conjunction with [`OpenAs.OVERLAY`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#openas), the child window acts as a modal dialog and the parent card is blocked until the child window closes." ], "type": "string" }, @@ -2300,7 +2300,7 @@ "OVERLAY" ], "enumDescriptions": [ - "The link opens as a full size window (if that's the frame used by the client.", + "The link opens as a full-size window (if that's the frame used by the client).", "The link opens as an overlay, such as a pop-up." ], "type": "string" @@ -2313,7 +2313,7 @@ "type": "object" }, "GoogleAppsCardV1Section": { - "description": "A section contains a collection of widgets that are rendered vertically in the order that they are specified.", + "description": "A section contains a collection of widgets that are rendered vertically in the order that they're specified.", "id": "GoogleAppsCardV1Section", "properties": { "collapsible": { @@ -2321,7 +2321,7 @@ "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 and Formatting text in Google Workspace Add-ons.", + "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/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "uncollapsibleWidgetsCount": { @@ -2330,7 +2330,7 @@ "type": "integer" }, "widgets": { - "description": "All the widgets in the section. Must contain at least 1 widget.", + "description": "All the widgets in the section. Must contain at least one widget.", "items": { "$ref": "GoogleAppsCardV1Widget" }, @@ -2405,14 +2405,14 @@ "id": "GoogleAppsCardV1SuggestionItem", "properties": { "text": { - "description": "The value of a suggested input to a text input field. This is equivalent to what users would enter themselves.", + "description": "The value of a suggested input to a text input field. This is equivalent to what users enter themselves.", "type": "string" } }, "type": "object" }, "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 just 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 is set to `MULTIPLE_LINE`.", + "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`.", "id": "GoogleAppsCardV1Suggestions", "properties": { "items": { @@ -2426,7 +2426,7 @@ "type": "object" }, "GoogleAppsCardV1SwitchControl": { - "description": "Either a toggle-style switch or a checkbox inside a `decoratedText` widget. Only supported on the `decoratedText` widget.", + "description": "Either a toggle-style switch or a checkbox inside a `decoratedText` widget. Only supported in the `decoratedText` widget.", "id": "GoogleAppsCardV1SwitchControl", "properties": { "controlType": { @@ -2476,10 +2476,10 @@ }, "initialSuggestions": { "$ref": "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 just 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 is set to `MULTIPLE_LINE`." + "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 just `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`." }, "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.", + "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": { @@ -2488,7 +2488,7 @@ }, "onChangeAction": { "$ref": "GoogleAppsCardV1Action", - "description": "What to do when a change occurs in the text input field. Examples of changes include a user adding to the field, or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/chat/how-tos/dialogs) in Google Chat." + "description": "What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/chat/how-tos/dialogs) in Google Chat." }, "type": { "description": "How a text input field appears in the user interface. For example, whether the field is single or multi-line.", @@ -2510,7 +2510,7 @@ "type": "object" }, "GoogleAppsCardV1TextParagraph": { - "description": "A paragraph of text that supports formatting. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.", + "description": "A paragraph of text that supports formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "id": "GoogleAppsCardV1TextParagraph", "properties": { "text": { @@ -2578,7 +2578,7 @@ }, "textParagraph": { "$ref": "GoogleAppsCardV1TextParagraph", - "description": "Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons. For example, the following JSON creates a bolded text: ``` \"textParagraph\": { \"text\": \" *bold text*\" } ```" + "description": "Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` \"textParagraph\": { \"text\": \" *bold text*\" } ```" } }, "type": "object" @@ -2619,11 +2619,11 @@ "type": "object" }, "Image": { - "description": "An image that is specified by a URL and can have an onclick action.", + "description": "An image that's specified by a URL and can have an `onclick` action.", "id": "Image", "properties": { "aspectRatio": { - "description": "The aspect ratio of this image (width/height). This field allows clients to reserve the right height for the image while waiting for it to load. It's not meant to override the native aspect ratio of the image. If unset, the server fills it by prefetching the image.", + "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" }, @@ -2633,17 +2633,17 @@ }, "onClick": { "$ref": "OnClick", - "description": "The onclick action." + "description": "The `onclick` action." } }, "type": "object" }, "ImageButton": { - "description": "An image button with an onclick action.", + "description": "An image button with an `onclick` action.", "id": "ImageButton", "properties": { "icon": { - "description": "The icon specified by an enum that indices to an icon provided by Chat API.", + "description": "The icon specified by an `enum` that indices to an icon provided by Chat API.", "enum": [ "ICON_UNSPECIFIED", "AIRPLANE", @@ -2717,12 +2717,12 @@ "type": "string" }, "name": { - "description": "The name of this image_button which will be used for accessibility. Default value will be provided if developers don't specify.", + "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": "OnClick", - "description": "The onclick action." + "description": "The `onclick` action." } }, "type": "object" @@ -2751,11 +2751,11 @@ "type": "object" }, "KeyValue": { - "description": "A UI element contains a key (label) and a value (content). And this element may also contain some actions such as onclick button.", + "description": "A UI element contains a key (label) and a value (content). This element can also contain some actions such as `onclick` button.", "id": "KeyValue", "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 and Formatting text in Google Workspace Add-ons.", + "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/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "button": { @@ -2763,7 +2763,7 @@ "description": "A button that can be clicked to trigger an action." }, "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 and Formatting text in Google Workspace Add-ons.", + "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/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "contentMultiline": { @@ -2771,7 +2771,7 @@ "type": "boolean" }, "icon": { - "description": "An enum value that will be replaced by the Chat API with the corresponding icon image.", + "description": "An enum value that's replaced by the Chat API with the corresponding icon image.", "enum": [ "ICON_UNSPECIFIED", "AIRPLANE", @@ -2846,10 +2846,10 @@ }, "onClick": { "$ref": "OnClick", - "description": "The onclick action. Only the top label, bottom label and content region are clickable." + "description": "The `onclick` action. Only the top label, bottom label, and content region are clickable." }, "topLabel": { - "description": "The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.", + "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/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" } }, @@ -2866,7 +2866,7 @@ "type": "array" }, "nextPageToken": { - "description": "A token that can be sent as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.", + "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" } }, @@ -2883,7 +2883,7 @@ "type": "array" }, "nextPageToken": { - "description": "A token that can be sent as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.", + "description": "You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.", "type": "string" } }, @@ -2893,7 +2893,7 @@ "id": "ListReactionsResponse", "properties": { "nextPageToken": { - "description": "Continuation token to retrieve the next page of results. It will be empty for the last page of results.", + "description": "Continuation token to retrieve the next page of results. It's empty for the last page of results.", "type": "string" }, "reactions": { @@ -2910,7 +2910,7 @@ "id": "ListSpacesResponse", "properties": { "nextPageToken": { - "description": "A token that can be sent as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.", + "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": { @@ -2924,11 +2924,11 @@ "type": "object" }, "MatchedUrl": { - "description": "A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links).", + "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).", "id": "MatchedUrl", "properties": { "url": { - "description": "Output only. The url that was matched.", + "description": "Output only. The URL that was matched.", "readOnly": true, "type": "string" } @@ -2961,7 +2961,7 @@ "description": "The Google Chat user or app the membership corresponds to. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`." }, "name": { - "description": "Resource name of the membership, assigned by the server. Format: spaces/{space}/members/{member}", + "description": "Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`", "type": "string" }, "role": { @@ -2974,7 +2974,7 @@ "enumDescriptions": [ "Default value. The user isn't a member of the space, but might be invited.", "A member of the space. The user has basic permissions, like sending messages to the space. In 1:1 and unnamed group conversations, everyone has this role.", - "A space manager. The user has all basic permissions plus administrative permissions that allow them to manage the space, like adding or removing members. Only supported in SpaceType.SPACE." + "A space manager. The user has all basic permissions plus administrative permissions that let them manage the space, like adding or removing members. Only supported in SpaceType.SPACE." ], "readOnly": true, "type": "string" @@ -2988,10 +2988,10 @@ "NOT_A_MEMBER" ], "enumDescriptions": [ - "Default, do not use.", + "Default, don't use.", "The user has joined the space.", - "The user has been invited, is able to join the space, but currently has not joined.", - "The user is not a member of the space, has not been invited and is not able to join the space." + "The user has been invited, is able to join the space, but currently hasn't joined.", + "The user isn't a member of the space, hasn't been invited and isn't able to join the space." ], "readOnly": true, "type": "string" @@ -3028,7 +3028,7 @@ "type": "array" }, "cards": { - "description": "Deprecated: Use `cards_v2` instead. Rich, formatted and interactive cards that can be used to display UI elements such as: formatted texts, buttons, 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.", + "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.", "items": { "$ref": "Card" }, @@ -3046,7 +3046,7 @@ "type": "string" }, "createTime": { - "description": "Output only. The time at which the message was created in Google Chat server.", + "description": "Output only. The time at which the message was created in Google Chat.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -3071,7 +3071,7 @@ "type": "array" }, "fallbackText": { - "description": "A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications).", + "description": "A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.", "type": "string" }, "lastUpdateTime": { @@ -3082,7 +3082,7 @@ }, "matchedUrl": { "$ref": "MatchedUrl", - "description": "Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links).", + "description": "Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links).", "readOnly": true }, "name": { @@ -3120,16 +3120,16 @@ "type": "object" }, "OnClick": { - "description": "An onclick action (e.g. open a link).", + "description": "An `onclick` action (for example, open a link).", "id": "OnClick", "properties": { "action": { "$ref": "FormAction", - "description": "A form action will be triggered by this onclick if specified." + "description": "A form action is triggered by this `onclick` action if specified." }, "openLink": { "$ref": "OpenLink", - "description": "This onclick triggers an open link action if specified." + "description": "This `onclick` action triggers an open link action if specified." } }, "type": "object" @@ -3154,7 +3154,7 @@ "description": "The emoji used in the reaction." }, "name": { - "description": "The resource name of the reaction. Format: spaces/{space}/messages/{message}/reactions/{reaction}", + "description": "The resource name of the reaction. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`", "type": "string" }, "user": { @@ -3166,15 +3166,15 @@ "type": "object" }, "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 is currently no need for layout properties (e.g. float).", + "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).", "id": "Section", "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 and Formatting text in Google Workspace Add-ons.", + "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/chat/api/guides/message-formats/cards#card_text_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 1 widget.", + "description": "A section must contain at least one widget.", "items": { "$ref": "WidgetMarkup" }, @@ -3210,7 +3210,7 @@ "id": "SlashCommand", "properties": { "commandId": { - "description": "The id of the slash command invoked.", + "description": "The ID of the slash command invoked.", "format": "int64", "type": "string" } @@ -3226,7 +3226,7 @@ "description": "The Chat app whose command was invoked." }, "commandId": { - "description": "The command id of the invoked slash command.", + "description": "The command ID of the invoked slash command.", "format": "int64", "type": "string" }, @@ -3235,7 +3235,7 @@ "type": "string" }, "triggersDialog": { - "description": "Indicating whether the slash command is for a dialog.", + "description": "Indicates whether the slash command is for a dialog.", "type": "boolean" }, "type": { @@ -3246,7 +3246,7 @@ "INVOKE" ], "enumDescriptions": [ - "Default value for the enum. DO NOT USE.", + "Default value for the enum. Don't use.", "Add Chat app to space.", "Invoke slash command in space." ], @@ -3265,11 +3265,11 @@ "type": "boolean" }, "displayName": { - "description": "The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). For direct messages, this field may be empty. Supports up to 128 characters.", + "description": "The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). For direct messages, this field might be empty. Supports up to 128 characters.", "type": "string" }, "name": { - "description": "Resource name of the space. Format: spaces/{space}", + "description": "Resource name of the space. Format: `spaces/{space}`", "type": "string" }, "singleUserBotDm": { @@ -3342,7 +3342,7 @@ "enumDescriptions": [ "", "Conversations between two or more humans.", - "1:1 Direct Message between a human and a Chat app, where all messages are flat. Note that this does not include direct messages between two humans." + "1:1 Direct Message between a human and a Chat app, where all messages are flat. Note that this doesn't include direct messages between two humans." ], "readOnly": true, "type": "string" @@ -3355,7 +3355,7 @@ "id": "SpaceDetails", "properties": { "description": { - "description": "Optional. A description of the space. It could describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters.", + "description": "Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters.", "type": "string" }, "guidelines": { @@ -3407,12 +3407,12 @@ "type": "object" }, "TextButton": { - "description": "A button with text and onclick action.", + "description": "A button with text and `onclick` action.", "id": "TextButton", "properties": { "onClick": { "$ref": "OnClick", - "description": "The onclick action of the button." + "description": "The `onclick` action of the button." }, "text": { "description": "The text of the button.", @@ -3422,7 +3422,7 @@ "type": "object" }, "TextParagraph": { - "description": "A paragraph of text. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.", + "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/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "id": "TextParagraph", "properties": { "text": { @@ -3436,7 +3436,7 @@ "id": "Thread", "properties": { "name": { - "description": "Resource name of the thread. Example: spaces/{space}/threads/{thread}", + "description": "Resource name of the thread. Example: `spaces/{space}/threads/{thread}`", "type": "string" }, "threadKey": { @@ -3551,7 +3551,7 @@ "MENTION" ], "enumDescriptions": [ - "Default value for the enum. DO NOT USE.", + "Default value for the enum. Don't use.", "Add user to space.", "Mention user in space." ], @@ -3565,7 +3565,7 @@ "type": "object" }, "WidgetMarkup": { - "description": "A widget is a UI element that presents texts, images, etc.", + "description": "A widget is a UI element that presents text and images.", "id": "WidgetMarkup", "properties": { "buttons": { diff --git a/chat/v1/chat-gen.go b/chat/v1/chat-gen.go index be102525233..96c50636622 100644 --- a/chat/v1/chat-gen.go +++ b/chat/v1/chat-gen.go @@ -267,8 +267,8 @@ type SpacesMessagesReactionsService struct { // ActionParameter: List of string parameters to supply when the action // method is invoked. For example, consider three snooze buttons: snooze -// now, snooze 1 day, snooze next week. You might use action method = -// snooze(), passing the snooze type and snooze time in the list of +// 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 ActionParameter struct { // Key: The name of the parameter for the action script. @@ -311,23 +311,23 @@ type ActionResponse struct { // Type: Input only. The type of Chat app response. // // Possible values: - // "TYPE_UNSPECIFIED" - Default type; will be handled as NEW_MESSAGE. + // "TYPE_UNSPECIFIED" - Default type that's handled as `NEW_MESSAGE`. // "NEW_MESSAGE" - Post as a new message in the topic. // "UPDATE_MESSAGE" - Update the Chat app's message. This is only - // permitted on a CARD_CLICKED event where the message sender type is - // BOT. + // permitted on a `CARD_CLICKED` event where the message sender type is + // `BOT`. // "UPDATE_USER_MESSAGE_CARDS" - Update the cards on a user's message. - // This is only permitted as a response to a MESSAGE event with a - // matched url, or a CARD_CLICKED event where the message sender type is - // HUMAN. Text will be ignored. - // "REQUEST_CONFIG" - Privately ask the user for additional auth or - // config. + // This is only permitted as a response to a `MESSAGE` event with a + // matched url, or a `CARD_CLICKED` event where the message sender type + // is `HUMAN`. Text is ignored. + // "REQUEST_CONFIG" - Privately ask the user for additional + // authentication or configuration. // "DIALOG" - Presents a // [dialog](https://developers.google.com/chat/how-tos/dialogs). Type string `json:"type,omitempty"` - // Url: Input only. URL for users to auth or config. (Only for - // REQUEST_CONFIG response types.) + // Url: Input only. URL for users to authenticate or configure. (Only + // for `REQUEST_CONFIG` response types.) Url string `json:"url,omitempty"` // ForceSendFields is a list of field names (e.g. "DialogAction") to @@ -498,8 +498,8 @@ type Annotation struct { // Type: The type of this annotation. // // Possible values: - // "ANNOTATION_TYPE_UNSPECIFIED" - Default value for the enum. DO NOT - // USE. + // "ANNOTATION_TYPE_UNSPECIFIED" - Default value for the enum. Don't + // use. // "USER_MENTION" - A user is mentioned. // "SLASH_COMMAND" - A slash command is invoked. Type string `json:"type,omitempty"` @@ -532,8 +532,8 @@ func (s *Annotation) MarshalJSON() ([]byte, error) { // Attachment: An attachment in Google Chat. type Attachment struct { - // AttachmentDataRef: A reference to the attachment data. This is used - // with the media API to download the attachment data. + // AttachmentDataRef: A reference to the attachment data. This field is + // used with the media API to download the attachment data. AttachmentDataRef *AttachmentDataRef `json:"attachmentDataRef,omitempty"` // ContentName: The original file name for the content, not the full @@ -544,16 +544,16 @@ type Attachment struct { ContentType string `json:"contentType,omitempty"` // DownloadUri: Output only. The download URL which should be used to - // allow a human user to download the attachment. Chat apps should not + // allow a human user to download the attachment. Chat apps shouldn't // use this URL to download attachment content. DownloadUri string `json:"downloadUri,omitempty"` - // DriveDataRef: A reference to the drive attachment. This is used with - // the Drive API. + // DriveDataRef: A reference to the drive attachment. This field is used + // with the Drive API. DriveDataRef *DriveDataRef `json:"driveDataRef,omitempty"` // Name: Resource name of the attachment, in the form - // "spaces/*/messages/*/attachments/*". + // `spaces/*/messages/*/attachments/*`. Name string `json:"name,omitempty"` // Source: The source of the attachment. @@ -565,7 +565,7 @@ type Attachment struct { Source string `json:"source,omitempty"` // ThumbnailUri: Output only. The thumbnail URL which should be used to - // preview the attachment to a human user. Chat apps should not use this + // preview the attachment to a human user. Chat apps shouldn't use this // URL to download attachment content. ThumbnailUri string `json:"thumbnailUri,omitempty"` @@ -604,8 +604,8 @@ type AttachmentDataRef struct { // (https://developers.google.com/workspace/preview). AttachmentUploadToken string `json:"attachmentUploadToken,omitempty"` - // ResourceName: The resource name of the attachment data. This is used - // with the media API to download the attachment data. + // ResourceName: The resource name of the attachment data. This field is + // used with the media API to download the attachment data. ResourceName string `json:"resourceName,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -635,10 +635,10 @@ func (s *AttachmentDataRef) MarshalJSON() ([]byte, error) { // Button: A button. Can be a text button or an image button. type Button struct { - // ImageButton: A button with image and onclick action. + // ImageButton: A button with image and `onclick` action. ImageButton *ImageButton `json:"imageButton,omitempty"` - // TextButton: A button with text and onclick action. + // TextButton: A button with text and `onclick` action. TextButton *TextButton `json:"textButton,omitempty"` // ForceSendFields is a list of field names (e.g. "ImageButton") to @@ -664,8 +664,8 @@ func (s *Button) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Card: A card is a UI element that can contain UI widgets such as -// texts, images. +// Card: A card is a UI element that can contain UI widgets such as text +// and images. type Card struct { // CardActions: The actions of this card. CardActions []*CardAction `json:"cardActions,omitempty"` @@ -738,7 +738,8 @@ func (s *CardAction) MarshalJSON() ([]byte, error) { } type CardHeader struct { - // ImageStyle: The image's type (e.g. square border or circular border). + // ImageStyle: The image's type (for example, square border or circular + // border). // // Possible values: // "IMAGE_STYLE_UNSPECIFIED" @@ -753,8 +754,8 @@ type CardHeader struct { Subtitle string `json:"subtitle,omitempty"` // Title: The title must be specified. The header has a fixed height: if - // both a title and subtitle is specified, each will take up 1 line. If - // only the title is specified, it will take up both lines. + // both a title and subtitle is specified, each takes up one line. If + // only the title is specified, it takes up both lines. Title string `json:"title,omitempty"` // ForceSendFields is a list of field names (e.g. "ImageStyle") to @@ -854,23 +855,23 @@ func (s *ChatAppLogEntry) MarshalJSON() ([]byte, error) { } // Color: Represents a color in the RGBA color space. This -// representation is designed for simplicity of conversion to/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 carry -// information about the absolute color space that should be used to -// interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, -// etc.). 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(), +// 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 does not 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 = @@ -1302,7 +1303,7 @@ func (s *DeprecatedEvent) MarshalJSON() ([]byte, error) { // Dialog: Wrapper around the card body of the dialog. type Dialog struct { // Body: Input only. Body of the dialog, which is rendered in a modal. - // Google Chat apps do not support the following card entities: + // Google Chat apps don't support the following card entities: // `DateTimePicker`, `OnChangeAction`. Body *GoogleAppsCardV1Card `json:"body,omitempty"` @@ -1368,7 +1369,7 @@ func (s *DialogAction) MarshalJSON() ([]byte, error) { // DriveDataRef: A reference to the data of a drive attachment. type DriveDataRef struct { - // DriveFileId: The id for the drive file, for use with the Drive API. + // DriveFileId: The ID for the drive file. Use with the Drive API. DriveFileId string `json:"driveFileId,omitempty"` // ForceSendFields is a list of field names (e.g. "DriveFileId") to @@ -1472,14 +1473,13 @@ type Empty struct { } // FormAction: A form action describes the behavior when the form is -// submitted. For example, an Apps Script can be invoked to handle the +// submitted. For example, you can invoke Apps Script to handle the // form. type FormAction struct { // ActionMethodName: 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. The same method - // name can be used for several elements that trigger a common behavior - // if desired. + // 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. ActionMethodName string `json:"actionMethodName,omitempty"` // Parameters: List of action parameters. @@ -1510,9 +1510,9 @@ func (s *FormAction) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1Action: An action that describes the behavior when -// the form is submitted. For example, an Apps Script can be invoked to -// handle the form. If the action is triggered, the form values are sent -// to the server. +// 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. type GoogleAppsCardV1Action struct { // Function: A custom function to invoke when the containing element is // clicked or othrwise activated. For example usage, see Create @@ -1522,14 +1522,14 @@ type GoogleAppsCardV1Action struct { // Interaction: Optional. Required when opening a dialog // (https://developers.google.com/chat/how-tos/dialogs). What to do in - // response to an interaction with a user, such as a user clicking - // button on 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 + // 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/chat/how-tos/dialogs). When specified, - // a loading indicator is not shown. Supported by Chat apps, but not + // a loading indicator isn't shown. Supported by Chat apps, but not // Google Workspace Add-ons. If specified for an add-on, the entire card // is stripped and nothing is shown in the client. // @@ -1559,17 +1559,18 @@ type GoogleAppsCardV1Action struct { // PersistValues: 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 + // 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/chat/api/guides/message-formats/cards) - // in Chat apps, you must also set the action's ResponseType + // in Chat apps, you must also set the action's `ResponseType` // (https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) // to `UPDATE_MESSAGE` and use the same `card_id` // (https://developers.google.com/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 + // 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`. PersistValues bool `json:"persistValues,omitempty"` @@ -1599,9 +1600,10 @@ func (s *GoogleAppsCardV1Action) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1ActionParameter: List of string parameters to supply // when the action method is invoked. For example, consider three snooze -// buttons: snooze now, snooze 1 day, 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 +// 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/chat/api/reference/rest/v1/Event#commoneventobject). type GoogleAppsCardV1ActionParameter struct { // Key: The name of the parameter for the action script. @@ -1673,30 +1675,30 @@ func (s *GoogleAppsCardV1BorderStyle) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleAppsCardV1Button: A text, icon, or text + icon button that +// GoogleAppsCardV1Button: A text, icon, or text and icon button that // users can click. To make an image a clickable button, specify an -// Image (not an ImageComponent) and set an `onClick` action. +// `Image` (not an `ImageComponent`) and set an `onClick` action. type GoogleAppsCardV1Button struct { - // AltText: The alternative text 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/chat". + // AltText: 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/chat". AltText string `json:"altText,omitempty"` // Color: If set, the button is filled with a solid background color and // the font color changes to maintain contrast with the background - // color. For example, setting a blue background will likely result in - // white text. If unset, the image background is white and the font - // color is blue. For red, green and blue, the value of each field is a - // `float` number that can be expressed in either of two ways: as a - // number between 0 and 255 divided by 255 (153/255) or as a value - // between 0 and 1 (0.6). 0 represents the absence of a color and 1 or - // 255/255 represent the full presence of that color on the RGB scale. - // Optionally set alpha, which sets a level of transparency using this + // color. For example, setting a blue background likely results in white + // text. If unset, the image background is white and the font color is + // blue. For red, green, and blue, the value of each field is a `float` + // number that you can express in either of two ways: as a number + // between 0 and 255 divided by 255 (153/255), or as a value between 0 + // and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 + // represent the full presence of that color on the RGB scale. + // Optionally set `alpha`, which sets a level of transparency using this // equation: ``` pixel color = alpha * (this color) + (1.0 - alpha) * - // (background color) ``` For alpha, a value of 1 corresponds with a - // solid color, and a value of 0 corresponds with a completely + // (background color) ``` For `alpha`, a value of `1` corresponds with a + // solid color, and a value of `0` corresponds with a completely // transparent color. For example, the following color represents a half // transparent red: ``` "color": { "red": 1, "green": 0, "blue": 0, // "alpha": 0.5 } ``` @@ -1710,8 +1712,8 @@ type GoogleAppsCardV1Button struct { // icon appears before the text. Icon *GoogleAppsCardV1Icon `json:"icon,omitempty"` - // OnClick: Required. The action to perform when the button is clicked, - // such as opening a hyperlink or running a custom function. + // OnClick: Required. The action to perform when a user clicks the + // button, such as opening a hyperlink or running a custom function. OnClick *GoogleAppsCardV1OnClick `json:"onClick,omitempty"` // Text: The text displayed inside the button. @@ -1776,10 +1778,10 @@ func (s *GoogleAppsCardV1ButtonList) MarshalJSON() ([]byte, error) { // message, just beneath the text message. - As a dialog // (https://developers.google.com/chat/how-tos/dialogs). The following // example JSON creates a "contact card" that features: - A header with -// the contact's name, job title, avatar picture. - A section with the -// contact information, including formatted text. - Buttons that users -// can click to share the contact or see more or less info. !Example -// contact card +// the contact's name, job title, and avatar picture. - A section with +// the contact information, including formatted text. - Buttons that +// users can click to share the contact, or see more or less +// information. !Example contact card // (https://developers.google.com/chat/images/card_api_reference.png) // ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": // { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": @@ -1801,8 +1803,8 @@ func (s *GoogleAppsCardV1ButtonList) MarshalJSON() ([]byte, error) { type GoogleAppsCardV1Card struct { // CardActions: The card's actions. Actions are added to the card's // toolbar menu. Because Chat app cards have no toolbar, `cardActions[]` - // is not supported by Chat apps. For example, the following JSON - // constructs a card action menu with Settings and Send Feedback + // isn't supported by Chat apps. 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": @@ -1815,7 +1817,7 @@ type GoogleAppsCardV1Card struct { // properties of the `peekCardHeader`. Not supported by Chat apps. // // Possible values: - // "DISPLAY_STYLE_UNSPECIFIED" - Do not use. + // "DISPLAY_STYLE_UNSPECIFIED" - Don't use. // "PEEK" - The header of the card appears at the bottom of the // sidebar, partially covering the current top card of the stack. // Clicking the header pops the card into the card stack. If the card @@ -1923,8 +1925,8 @@ type GoogleAppsCardV1CardFixedFooter struct { PrimaryButton *GoogleAppsCardV1Button `json:"primaryButton,omitempty"` // SecondaryButton: The secondary button of the fixed footer. The button - // must be a text button with text and color set. `primaryButton` must - // be set if `secondaryButton` is set. + // must be a text button with text and color set. If `secondaryButton` + // is set, you must also set `primaryButton`. SecondaryButton *GoogleAppsCardV1Button `json:"secondaryButton,omitempty"` // Widgets: A list of widgets included in the card footer. Primary @@ -1956,7 +1958,7 @@ func (s *GoogleAppsCardV1CardFixedFooter) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1CardHeader: Represents a card header. type GoogleAppsCardV1CardHeader struct { - // ImageAltText: The alternative text of this image which is used for + // ImageAltText: The alternative text of this image that's used for // accessibility. ImageAltText string `json:"imageAltText,omitempty"` @@ -2036,7 +2038,7 @@ type GoogleAppsCardV1Column struct { // bottom, or center of a column. // // Possible values: - // "VERTICAL_ALIGNMENT_UNSPECIFIED" - Unspecified. Do not use. + // "VERTICAL_ALIGNMENT_UNSPECIFIED" - Unspecified. Don't use. // "CENTER" - Default value. Aligns widgets to the center of a column. // "TOP" - Aligns widgets to the top of a column. // "BOTTOM" - Aligns widgets to the bottom of a column. @@ -2187,12 +2189,12 @@ func (s *GoogleAppsCardV1DateTimePicker) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1DecoratedText: 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. +// in front of the text, a selection widget, or a button after the text. type GoogleAppsCardV1DecoratedText struct { // BottomLabel: The text that appears below `text`. Always truncates. BottomLabel string `json:"bottomLabel,omitempty"` - // Button: A button that can be clicked to trigger an action. + // Button: A button that a user can click to trigger an action. Button *GoogleAppsCardV1Button `json:"button,omitempty"` // EndIcon: An icon displayed after the text. Supports built-in @@ -2205,20 +2207,23 @@ type GoogleAppsCardV1DecoratedText struct { // Icon: Deprecated in favor of `startIcon`. Icon *GoogleAppsCardV1Icon `json:"icon,omitempty"` - // OnClick: When users click on `topLabel` or `bottomLabel`, this action - // triggers. + // OnClick: This action is triggered when users click `topLabel` or + // `bottomLabel`. OnClick *GoogleAppsCardV1OnClick `json:"onClick,omitempty"` // StartIcon: The icon displayed in front of the text. StartIcon *GoogleAppsCardV1Icon `json:"startIcon,omitempty"` - // SwitchControl: A switch widget can be clicked to change its state and - // trigger an action. + // SwitchControl: A switch widget that a user can click to change its + // state and trigger an action. SwitchControl *GoogleAppsCardV1SwitchControl `json:"switchControl,omitempty"` // Text: Required. The primary text. Supports simple formatting. For // more information about formatting text, see Formatting text in Google - // Chat apps and Formatting text in Google Workspace Add-ons. + // Chat apps + // (https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) + // and Formatting text in Google Workspace Add-ons + // (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). Text string `json:"text,omitempty"` // TopLabel: The text that appears above `text`. Always truncates. @@ -2252,7 +2257,7 @@ func (s *GoogleAppsCardV1DecoratedText) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleAppsCardV1Divider: Displays a divider between widgets, a +// GoogleAppsCardV1Divider: Displays a divider between widgets as a // horizontal line. For example, the following JSON creates a divider: // ``` "divider": {} ``` type GoogleAppsCardV1Divider struct { @@ -2360,7 +2365,7 @@ func (s *GoogleAppsCardV1Grid) MarshalJSON() ([]byte, error) { // can contain text, an image, or both text and an image. type GoogleAppsCardV1GridItem struct { // Id: A user-specified identifier for this grid item. This identifier - // is returned in the parent Grid's onClick callback parameters. + // is returned in the parent grid's `onClick` callback parameters. Id string `json:"id,omitempty"` // Image: The image that displays in the grid item. @@ -2413,15 +2418,15 @@ func (s *GoogleAppsCardV1GridItem) MarshalJSON() ([]byte, error) { // icons. type GoogleAppsCardV1Icon struct { // AltText: Optional. A description of the icon used for accessibility. - // If unspecified, the default value "Button" is provided. As a best + // 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/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. + // https://developers.google.com/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. AltText string `json:"altText,omitempty"` // IconUrl: Display a custom icon hosted at an HTTPS URL. For example: @@ -2474,15 +2479,16 @@ func (s *GoogleAppsCardV1Icon) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1Image: An image that is specified by a URL and can // have an `onClick` action. type GoogleAppsCardV1Image struct { - // AltText: The alternative text of this image, used for accessibility. + // AltText: The alternative text of this image that's used for + // accessibility. AltText string `json:"altText,omitempty"` - // ImageUrl: The `https` URL that hosts the image. For example: ``` + // ImageUrl: The HTTPS URL that hosts the image. For example: ``` // https://developers.google.com/chat/images/quickstart-app-avatar.png // ``` ImageUrl string `json:"imageUrl,omitempty"` - // OnClick: When a user clicks on the image, the click triggers this + // OnClick: When a user clicks the image, the click triggers this // action. OnClick *GoogleAppsCardV1OnClick `json:"onClick,omitempty"` @@ -2547,11 +2553,11 @@ func (s *GoogleAppsCardV1ImageComponent) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1ImageCropStyle: Represents the crop style applied to -// an image. For example, here's how to apply a 16 by 9 aspect ratio: -// ``` cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 } ``` +// an image. For example, here's how to apply a 16:9 aspect ratio: ``` +// cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 } ``` type GoogleAppsCardV1ImageCropStyle struct { // AspectRatio: The aspect ratio to use if the crop type is - // `RECTANGLE_CUSTOM`. For example, here's how to apply a 16 by 9 aspect + // `RECTANGLE_CUSTOM`. For example, here's how to apply a 16:9 aspect // ratio: ``` cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": // 16/9 } ``` AspectRatio float64 `json:"aspectRatio,omitempty"` @@ -2559,7 +2565,7 @@ type GoogleAppsCardV1ImageCropStyle struct { // Type: The crop type. // // Possible values: - // "IMAGE_CROP_TYPE_UNSPECIFIED" - No value specified. Do not use. + // "IMAGE_CROP_TYPE_UNSPECIFIED" - No value specified. Don't use. // "SQUARE" - Default value. Applies a square crop. // "CIRCLE" - Applies a circular crop. // "RECTANGLE_CUSTOM" - Applies a rectangular crop with a custom @@ -2655,12 +2661,12 @@ type GoogleAppsCardV1OpenLink struct { // observes it until the window closes. Not supported by Chat apps. // // Possible values: - // "NOTHING" - Default value. The card does not reload; nothing + // "NOTHING" - Default value. The card doesn't reload; nothing // happens. // "RELOAD" - Reloads the card after the child window closes. If used // in conjunction with - // [OpenAs.OVERLAY](https://developers.google.com/workspace/add-ons/refer - // ence/rpc/google.apps.card.v1#openas), the child window acts as a + // [`OpenAs.OVERLAY`](https://developers.google.com/workspace/add-ons/ref + // erence/rpc/google.apps.card.v1#openas), the child window acts as a // modal dialog and the parent card is blocked until the child window // closes. OnClose string `json:"onClose,omitempty"` @@ -2668,8 +2674,8 @@ type GoogleAppsCardV1OpenLink struct { // OpenAs: How to open a link. Not supported by Chat apps. // // Possible values: - // "FULL_SIZE" - The link opens as a full size window (if that's the - // frame used by the client. + // "FULL_SIZE" - The link opens as a full-size window (if that's the + // frame used by the client). // "OVERLAY" - The link opens as an overlay, such as a pop-up. OpenAs string `json:"openAs,omitempty"` @@ -2700,7 +2706,7 @@ func (s *GoogleAppsCardV1OpenLink) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1Section: A section contains a collection of widgets -// that are rendered vertically in the order that they are specified. +// that are rendered vertically in the order that they're specified. type GoogleAppsCardV1Section struct { // Collapsible: Indicates whether this section is collapsible. // Collapsible sections hide some or all widgets, but users can expand @@ -2712,8 +2718,10 @@ type GoogleAppsCardV1Section struct { // Header: 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 and Formatting text in Google - // Workspace Add-ons. + // Formatting text in Google Chat apps + // (https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) + // and Formatting text in Google Workspace Add-ons + // (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). Header string `json:"header,omitempty"` // UncollapsibleWidgetsCount: The number of uncollapsible widgets which @@ -2724,7 +2732,7 @@ type GoogleAppsCardV1Section struct { // into account only when `collapsible` is `true`. UncollapsibleWidgetsCount int64 `json:"uncollapsibleWidgetsCount,omitempty"` - // Widgets: All the widgets in the section. Must contain at least 1 + // Widgets: All the widgets in the section. Must contain at least one // widget. Widgets []*GoogleAppsCardV1Widget `json:"widgets,omitempty"` @@ -2868,7 +2876,7 @@ func (s *GoogleAppsCardV1SelectionItem) MarshalJSON() ([]byte, error) { // enter in a text input field. type GoogleAppsCardV1SuggestionItem struct { // Text: The value of a suggested input to a text input field. This is - // equivalent to what users would enter themselves. + // equivalent to what users enter themselves. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "Text") to @@ -2899,13 +2907,13 @@ func (s *GoogleAppsCardV1SuggestionItem) MarshalJSON() ([]byte, error) { // 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 just Java -// and JavaScript. Suggested values help guide users to enter values +// 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 is -// set to `MULTIPLE_LINE`. +// 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`. type GoogleAppsCardV1Suggestions struct { // Items: A list of suggestions used for autocomplete recommendations in // text input fields. @@ -2935,7 +2943,7 @@ func (s *GoogleAppsCardV1Suggestions) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1SwitchControl: Either a toggle-style switch or a -// checkbox inside a `decoratedText` widget. Only supported on the +// checkbox inside a `decoratedText` widget. Only supported in the // `decoratedText` widget. type GoogleAppsCardV1SwitchControl struct { // ControlType: How the switch appears in the user interface. @@ -3016,19 +3024,19 @@ type GoogleAppsCardV1TextInput struct { // 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 just Java and - // JavaScript. Suggested values help guide users to enter values that + // typing `Jav`, the list of suggestions filters to show just `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 is - // set to `MULTIPLE_LINE`. + // 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`. InitialSuggestions *GoogleAppsCardV1Suggestions `json:"initialSuggestions,omitempty"` // Label: 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". + // specifically need their surname, write `surname` instead of `name`. // Required if `hintText` is unspecified. Otherwise, optional. Label string `json:"label,omitempty"` @@ -3039,10 +3047,10 @@ type GoogleAppsCardV1TextInput struct { Name string `json:"name,omitempty"` // OnChangeAction: What to do when a change occurs in the text input - // field. Examples of changes include a user adding to the field, or - // deleting text. Examples of actions to take include running a custom - // function or opening a dialog - // (https://developers.google.com/chat/how-tos/dialogs) in Google Chat. + // field. For example, a user adding to the field or deleting text. + // Examples of actions to take include running a custom function or + // opening a dialog (https://developers.google.com/chat/how-tos/dialogs) + // in Google Chat. OnChangeAction *GoogleAppsCardV1Action `json:"onChangeAction,omitempty"` // Type: How a text input field appears in the user interface. For @@ -3087,8 +3095,10 @@ func (s *GoogleAppsCardV1TextInput) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1TextParagraph: A paragraph of text that supports // formatting. For more information about formatting text, see -// Formatting text in Google Chat apps and Formatting text in Google -// Workspace Add-ons. +// Formatting text in Google Chat apps +// (https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) +// and Formatting text in Google Workspace Add-ons +// (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). type GoogleAppsCardV1TextParagraph struct { // Text: The text that's shown in the widget. Text string `json:"text,omitempty"` @@ -3219,9 +3229,12 @@ type GoogleAppsCardV1Widget struct { // TextParagraph: Displays a text paragraph. Supports simple HTML // formatted text. For more information about formatting text, see - // Formatting text in Google Chat apps and Formatting text in Google - // Workspace Add-ons. For example, the following JSON creates a bolded - // text: ``` "textParagraph": { "text": " *bold text*" } ``` + // Formatting text in Google Chat apps + // (https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) + // and Formatting text in Google Workspace Add-ons + // (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). + // For example, the following JSON creates a bolded text: ``` + // "textParagraph": { "text": " *bold text*" } ``` TextParagraph *GoogleAppsCardV1TextParagraph `json:"textParagraph,omitempty"` // ForceSendFields is a list of field names (e.g. "ButtonList") to @@ -3294,20 +3307,19 @@ func (s *GoogleAppsCardV1Widgets) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Image: An image that is specified by a URL and can have an onclick +// Image: An image that's specified by a URL and can have an `onclick` // action. type Image struct { - // AspectRatio: The aspect ratio of this image (width/height). This - // field allows clients to reserve the right height for the image while - // waiting for it to load. It's not meant to override the native aspect - // ratio of the image. If unset, the server fills it by prefetching the - // image. + // AspectRatio: 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. AspectRatio float64 `json:"aspectRatio,omitempty"` // ImageUrl: The URL of the image. ImageUrl string `json:"imageUrl,omitempty"` - // OnClick: The onclick action. + // OnClick: The `onclick` action. OnClick *OnClick `json:"onClick,omitempty"` // ForceSendFields is a list of field names (e.g. "AspectRatio") to @@ -3347,10 +3359,10 @@ func (s *Image) UnmarshalJSON(data []byte) error { return nil } -// ImageButton: An image button with an onclick action. +// ImageButton: An image button with an `onclick` action. type ImageButton struct { - // Icon: The icon specified by an enum that indices to an icon provided - // by Chat API. + // Icon: The icon specified by an `enum` that indices to an icon + // provided by Chat API. // // Possible values: // "ICON_UNSPECIFIED" @@ -3389,12 +3401,11 @@ type ImageButton struct { // IconUrl: The icon specified by a URL. IconUrl string `json:"iconUrl,omitempty"` - // Name: The name of this image_button which will be used for - // accessibility. Default value will be provided if developers don't - // specify. + // Name: The name of this `image_button` that's used for accessibility. + // Default value is provided if this name isn't specified. Name string `json:"name,omitempty"` - // OnClick: The onclick action. + // OnClick: The `onclick` action. OnClick *OnClick `json:"onClick,omitempty"` // ForceSendFields is a list of field names (e.g. "Icon") to @@ -3461,12 +3472,14 @@ func (s *Inputs) MarshalJSON() ([]byte, error) { } // KeyValue: A UI element contains a key (label) and a value (content). -// And this element may also contain some actions such as onclick -// button. +// This element can also contain some actions such as `onclick` button. type KeyValue struct { // BottomLabel: The text of the bottom label. Formatted text supported. // For more information about formatting text, see Formatting text in - // Google Chat apps and Formatting text in Google Workspace Add-ons. + // Google Chat apps + // (https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) + // and Formatting text in Google Workspace Add-ons + // (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). BottomLabel string `json:"bottomLabel,omitempty"` // Button: A button that can be clicked to trigger an action. @@ -3474,14 +3487,16 @@ type KeyValue struct { // Content: The text of the content. Formatted text supported and always // required. For more information about formatting text, see Formatting - // text in Google Chat apps and Formatting text in Google Workspace - // Add-ons. + // text in Google Chat apps + // (https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) + // and Formatting text in Google Workspace Add-ons + // (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). Content string `json:"content,omitempty"` // ContentMultiline: If the content should be multiline. ContentMultiline bool `json:"contentMultiline,omitempty"` - // Icon: An enum value that will be replaced by the Chat API with the + // Icon: An enum value that's replaced by the Chat API with the // corresponding icon image. // // Possible values: @@ -3521,13 +3536,16 @@ type KeyValue struct { // IconUrl: The icon specified by a URL. IconUrl string `json:"iconUrl,omitempty"` - // OnClick: The onclick action. Only the top label, bottom label and + // OnClick: The `onclick` action. Only the top label, bottom label, and // content region are clickable. OnClick *OnClick `json:"onClick,omitempty"` // TopLabel: The text of the top label. Formatted text supported. For // more information about formatting text, see Formatting text in Google - // Chat apps and Formatting text in Google Workspace Add-ons. + // Chat apps + // (https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) + // and Formatting text in Google Workspace Add-ons + // (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). TopLabel string `json:"topLabel,omitempty"` // ForceSendFields is a list of field names (e.g. "BottomLabel") to @@ -3557,7 +3575,7 @@ type ListMembershipsResponse struct { // Memberships: List of memberships in the requested (or first) page. Memberships []*Membership `json:"memberships,omitempty"` - // NextPageToken: A token that can be sent as `pageToken` to retrieve + // NextPageToken: A token that you can send as `pageToken` to retrieve // the next page of results. If empty, there are no subsequent pages. NextPageToken string `json:"nextPageToken,omitempty"` @@ -3592,8 +3610,8 @@ type ListMessagesResponse struct { // Messages: List of messages. Messages []*Message `json:"messages,omitempty"` - // NextPageToken: A token that can be sent as `pageToken` to retrieve - // the next page of results. If empty, there are no subsequent pages. + // NextPageToken: You can send a token as `pageToken` to retrieve the + // next page of results. If empty, there are no subsequent pages. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -3625,7 +3643,7 @@ func (s *ListMessagesResponse) MarshalJSON() ([]byte, error) { type ListReactionsResponse struct { // NextPageToken: Continuation token to retrieve the next page of - // results. It will be empty for the last page of results. + // results. It's empty for the last page of results. NextPageToken string `json:"nextPageToken,omitempty"` // Reactions: List of reactions in the requested (or first) page. @@ -3659,8 +3677,8 @@ func (s *ListReactionsResponse) MarshalJSON() ([]byte, error) { } type ListSpacesResponse struct { - // NextPageToken: A token that can be sent as `pageToken` to retrieve - // the next page of results. If empty, there are no subsequent pages. + // NextPageToken: You can send a token as `pageToken` to retrieve the + // next page of results. If empty, there are no subsequent pages. NextPageToken string `json:"nextPageToken,omitempty"` // Spaces: List of spaces in the requested (or first) page. @@ -3693,11 +3711,11 @@ func (s *ListSpacesResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// MatchedUrl: A matched url in a Chat message. Chat apps can preview -// matched URLs. For more information, refer to Preview links +// MatchedUrl: 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 MatchedUrl struct { - // Url: Output only. The url that was matched. + // Url: Output only. The URL that was matched. Url string `json:"url,omitempty"` // ForceSendFields is a list of field names (e.g. "Url") to @@ -3772,7 +3790,7 @@ type Membership struct { Member *User `json:"member,omitempty"` // Name: Resource name of the membership, assigned by the server. - // Format: spaces/{space}/members/{member} + // Format: `spaces/{space}/members/{member}` Name string `json:"name,omitempty"` // Role: Output only. User's role within a Chat space, which determines @@ -3785,20 +3803,20 @@ type Membership struct { // permissions, like sending messages to the space. In 1:1 and unnamed // group conversations, everyone has this role. // "ROLE_MANAGER" - A space manager. The user has all basic - // permissions plus administrative permissions that allow them to manage - // the space, like adding or removing members. Only supported in + // permissions plus administrative permissions that let them manage the + // space, like adding or removing members. Only supported in // SpaceType.SPACE. Role string `json:"role,omitempty"` // State: Output only. State of the membership. // // Possible values: - // "MEMBERSHIP_STATE_UNSPECIFIED" - Default, do not use. + // "MEMBERSHIP_STATE_UNSPECIFIED" - Default, don't use. // "JOINED" - The user has joined the space. // "INVITED" - The user has been invited, is able to join the space, - // but currently has not joined. - // "NOT_A_MEMBER" - The user is not a member of the space, has not - // been invited and is not able to join the space. + // but currently hasn't joined. + // "NOT_A_MEMBER" - The user isn't a member of the space, hasn't been + // invited and isn't able to join the space. State string `json:"state,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -3845,9 +3863,9 @@ type Message struct { // Attachment: User-uploaded attachment. Attachment []*Attachment `json:"attachment,omitempty"` - // Cards: Deprecated: Use `cards_v2` instead. Rich, formatted and - // interactive cards that can be used to display UI elements such as: - // formatted texts, buttons, clickable images. Cards are normally + // Cards: 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. Cards []*Card `json:"cards,omitempty"` @@ -3874,7 +3892,7 @@ type Message struct { ClientAssignedMessageId string `json:"clientAssignedMessageId,omitempty"` // CreateTime: Output only. The time at which the message was created in - // Google Chat server. + // Google Chat. CreateTime string `json:"createTime,omitempty"` // DeleteTime: Output only. The time at which the message was deleted in @@ -3894,8 +3912,8 @@ type Message struct { EmojiReactionSummaries []*EmojiReactionSummary `json:"emojiReactionSummaries,omitempty"` // FallbackText: A plain-text description of the message's cards, used - // when the actual cards cannot be displayed (e.g. mobile - // notifications). + // when the actual cards can't be displayed—for example, mobile + // notifications. FallbackText string `json:"fallbackText,omitempty"` // LastUpdateTime: Output only. The time at which the message was last @@ -3904,7 +3922,7 @@ type Message struct { LastUpdateTime string `json:"lastUpdateTime,omitempty"` // MatchedUrl: Output only. A URL in `spaces.messages.text` that matches - // a link preview pattern. For more information, refer to Preview links + // a link preview pattern. For more information, see Preview links // (https://developers.google.com/chat/how-tos/preview-links). MatchedUrl *MatchedUrl `json:"matchedUrl,omitempty"` @@ -3974,12 +3992,14 @@ func (s *Message) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// OnClick: An onclick action (e.g. open a link). +// OnClick: An `onclick` action (for example, open a link). type OnClick struct { - // Action: A form action will be triggered by this onclick if specified. + // Action: A form action is triggered by this `onclick` action if + // specified. Action *FormAction `json:"action,omitempty"` - // OpenLink: This onclick triggers an open link action if specified. + // OpenLink: This `onclick` action triggers an open link action if + // specified. OpenLink *OpenLink `json:"openLink,omitempty"` // ForceSendFields is a list of field names (e.g. "Action") to @@ -4040,7 +4060,7 @@ type Reaction struct { Emoji *Emoji `json:"emoji,omitempty"` // Name: The resource name of the reaction. Format: - // spaces/{space}/messages/{message}/reactions/{reaction} + // `spaces/{space}/messages/{message}/reactions/{reaction}` Name string `json:"name,omitempty"` // User: Output only. The user who created the reaction. @@ -4075,15 +4095,18 @@ func (s *Reaction) MarshalJSON() ([]byte, error) { // Section: 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 is currently no -// need for layout properties (e.g. float). +// platforms, cards have a narrow fixed width, so there's currently no +// need for layout properties (for example, float). type Section struct { // Header: The header of the section. Formatted text is supported. For // more information about formatting text, see Formatting text in Google - // Chat apps and Formatting text in Google Workspace Add-ons. + // Chat apps + // (https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) + // and Formatting text in Google Workspace Add-ons + // (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). Header string `json:"header,omitempty"` - // Widgets: A section must contain at least 1 widget. + // Widgets: A section must contain at least one widget. Widgets []*WidgetMarkup `json:"widgets,omitempty"` // ForceSendFields is a list of field names (e.g. "Header") to @@ -4175,7 +4198,7 @@ func (s *SetUpSpaceRequest) MarshalJSON() ([]byte, error) { // (https://developers.google.com/chat/how-tos/slash-commands) in Google // Chat. type SlashCommand struct { - // CommandId: The id of the slash command invoked. + // CommandId: The ID of the slash command invoked. CommandId int64 `json:"commandId,omitempty,string"` // ForceSendFields is a list of field names (e.g. "CommandId") to @@ -4206,19 +4229,19 @@ type SlashCommandMetadata struct { // Bot: The Chat app whose command was invoked. Bot *User `json:"bot,omitempty"` - // CommandId: The command id of the invoked slash command. + // CommandId: The command ID of the invoked slash command. CommandId int64 `json:"commandId,omitempty,string"` // CommandName: The name of the invoked slash command. CommandName string `json:"commandName,omitempty"` - // TriggersDialog: Indicating whether the slash command is for a dialog. + // TriggersDialog: Indicates whether the slash command is for a dialog. TriggersDialog bool `json:"triggersDialog,omitempty"` // Type: The type of slash command. // // Possible values: - // "TYPE_UNSPECIFIED" - Default value for the enum. DO NOT USE. + // "TYPE_UNSPECIFIED" - Default value for the enum. Don't use. // "ADD" - Add Chat app to space. // "INVOKE" - Invoke slash command in space. Type string `json:"type,omitempty"` @@ -4259,11 +4282,11 @@ type Space struct { // DisplayName: The space's display name. Required when creating a space // (https://developers.google.com/chat/api/reference/rest/v1/spaces/create). - // For direct messages, this field may be empty. Supports up to 128 + // For direct messages, this field might be empty. Supports up to 128 // characters. DisplayName string `json:"displayName,omitempty"` - // Name: Resource name of the space. Format: spaces/{space} + // Name: Resource name of the space. Format: `spaces/{space}` Name string `json:"name,omitempty"` // SingleUserBotDm: Optional. Whether the space is a DM between a Chat @@ -4326,7 +4349,7 @@ type Space struct { // "TYPE_UNSPECIFIED" // "ROOM" - Conversations between two or more humans. // "DM" - 1:1 Direct Message between a human and a Chat app, where all - // messages are flat. Note that this does not include direct messages + // messages are flat. Note that this doesn't include direct messages // between two humans. Type string `json:"type,omitempty"` @@ -4361,9 +4384,9 @@ func (s *Space) MarshalJSON() ([]byte, error) { // SpaceDetails: Details about the space including description and // rules. type SpaceDetails struct { - // Description: Optional. A description of the space. It could describe - // the space's discussion topic, functional purpose, or participants. - // Supports up to 150 characters. + // Description: Optional. A description of the space. For example, + // describe the space's discussion topic, functional purpose, or + // participants. Supports up to 150 characters. Description string `json:"description,omitempty"` // Guidelines: Optional. The space's rules, expectations, and etiquette. @@ -4467,9 +4490,9 @@ func (s *StringInputs) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TextButton: A button with text and onclick action. +// TextButton: A button with text and `onclick` action. type TextButton struct { - // OnClick: The onclick action of the button. + // OnClick: The `onclick` action of the button. OnClick *OnClick `json:"onClick,omitempty"` // Text: The text of the button. @@ -4500,7 +4523,10 @@ func (s *TextButton) MarshalJSON() ([]byte, error) { // TextParagraph: A paragraph of text. Formatted text supported. For // more information about formatting text, see Formatting text in Google -// Chat apps and Formatting text in Google Workspace Add-ons. +// Chat apps +// (https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) +// and Formatting text in Google Workspace Add-ons +// (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). type TextParagraph struct { Text string `json:"text,omitempty"` @@ -4530,7 +4556,7 @@ func (s *TextParagraph) MarshalJSON() ([]byte, error) { // Thread: A thread in Google Chat. type Thread struct { // Name: Resource name of the thread. Example: - // spaces/{space}/threads/{thread} + // `spaces/{space}/threads/{thread}` Name string `json:"name,omitempty"` // ThreadKey: Optional. Opaque thread identifier. To start or add to a @@ -4755,7 +4781,7 @@ type UserMentionMetadata struct { // Type: The type of user mention. // // Possible values: - // "TYPE_UNSPECIFIED" - Default value for the enum. DO NOT USE. + // "TYPE_UNSPECIFIED" - Default value for the enum. Don't use. // "ADD" - Add user to space. // "MENTION" - Mention user in space. Type string `json:"type,omitempty"` @@ -4786,8 +4812,7 @@ func (s *UserMentionMetadata) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// WidgetMarkup: A widget is a UI element that presents texts, images, -// etc. +// WidgetMarkup: A widget is a UI element that presents text and images. type WidgetMarkup struct { // Buttons: A list of buttons. Buttons is also `oneof data` and only one // of these fields should be set. @@ -5239,7 +5264,7 @@ type SpacesCreateCall struct { // Create: Developer Preview // (https://developers.google.com/workspace/preview): Creates a named -// space. Spaces grouped by topics or that have guest access are not +// space. Spaces grouped by topics or that have guest access aren't // supported. Requires user authentication // (https://developers.google.com/chat/api/guides/auth/users) and the // `chat.spaces.create` or `chat.spaces` scope. @@ -5347,7 +5372,7 @@ func (c *SpacesCreateCall) Do(opts ...googleapi.CallOption) (*Space, error) { } return ret, nil // { - // "description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a named space. Spaces grouped by topics or that have guest access are not supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.", + // "description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a named space. Spaces grouped by topics or that have guest access aren't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.", // "flatPath": "v1/spaces", // "httpMethod": "POST", // "id": "chat.spaces.create", @@ -5387,14 +5412,15 @@ type SpacesDeleteCall struct { // Delete: Developer Preview // (https://developers.google.com/workspace/preview): 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. Requires user +// space's child resources—like messages posted in the space and +// memberships in the space—are also deleted. Requires user // authentication // (https://developers.google.com/chat/api/guides/auth/users) from a // user who has permission to delete the space, and the `chat.delete` // scope. // -// - name: Resource name of the space to delete. Format: spaces/{space}. +// - name: Resource name of the space to delete. Format: +// `spaces/{space}`. func (r *SpacesService) Delete(name string) *SpacesDeleteCall { c := &SpacesDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -5487,7 +5513,7 @@ func (c *SpacesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error) { } return ret, nil // { - // "description": "[Developer Preview](https://developers.google.com/workspace/preview): 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. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who has permission to delete the space, and the `chat.delete` scope.", + // "description": "[Developer Preview](https://developers.google.com/workspace/preview): 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. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who has permission to delete the space, and the `chat.delete` scope.", // "flatPath": "v1/spaces/{spacesId}", // "httpMethod": "DELETE", // "id": "chat.spaces.delete", @@ -5496,7 +5522,7 @@ func (c *SpacesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error) { // ], // "parameters": { // "name": { - // "description": "Required. Resource name of the space to delete. Format: spaces/{space}", + // "description": "Required. Resource name of the space to delete. Format: `spaces/{space}`", // "location": "path", // "pattern": "^spaces/[^/]+$", // "required": true, @@ -5544,12 +5570,12 @@ func (r *SpacesService) FindDirectMessage() *SpacesFindDirectMessageCall { } // Name sets the optional parameter "name": Required. Resource name of -// the user to find direct message with. Format: users/{user}, where +// the user to find direct message with. Format: `users/{user}`, where // `{user}` is either the `{person_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 Admin SDK Directory API. For example, if the People API +// in the Directory API. For example, if the People API // `Person.resourceName` is `people/123456789`, you can find a direct // message with that person by using `users/123456789` as the `name`. func (c *SpacesFindDirectMessageCall) Name(name string) *SpacesFindDirectMessageCall { @@ -5660,7 +5686,7 @@ func (c *SpacesFindDirectMessageCall) Do(opts ...googleapi.CallOption) (*Space, // "parameterOrder": [], // "parameters": { // "name": { - // "description": "Required. Resource name of the user to find direct message with. Format: users/{user}, where `{user}` is either the `{person_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 Admin SDK Directory API. For example, if the People API `Person.resourceName` is `people/123456789`, you can find a direct message with that person by using `users/123456789` as the `name`.", + // "description": "Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `{person_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 `Person.resourceName` is `people/123456789`, you can find a direct message with that person by using `users/123456789` as the `name`.", // "location": "query", // "type": "string" // } @@ -5702,7 +5728,7 @@ type SpacesGetCall struct { // the `chat.spaces` or `chat.spaces.readonly` authorization scope. // // - name: Resource name of the space, in the form "spaces/*". Format: -// spaces/{space}. +// `spaces/{space}`. func (r *SpacesService) Get(name string) *SpacesGetCall { c := &SpacesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -5817,7 +5843,7 @@ func (c *SpacesGetCall) Do(opts ...googleapi.CallOption) (*Space, error) { // ], // "parameters": { // "name": { - // "description": "Required. Resource name of the space, in the form \"spaces/*\". Format: spaces/{space}", + // "description": "Required. Resource name of the space, in the form \"spaces/*\". Format: `spaces/{space}`", // "location": "path", // "pattern": "^spaces/[^/]+$", // "required": true, @@ -5870,8 +5896,8 @@ func (r *SpacesService) List() *SpacesListCall { // (https://developers.google.com/chat/api/guides/auth/users). You can // filter spaces by the space type (`space_type` // (https://developers.google.com/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` cannot be +// 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 = @@ -5879,8 +5905,8 @@ func (r *SpacesService) List() *SpacesListCall { // an `INVALID_ARGUMENT` error. With service account authentication // (https://developers.google.com/chat/api/guides/auth/service-accounts), // this field is ignored and the query always returns all spaces. But -// Chat API still validates the query syntax with service accounts, so -// invalid queries are still rejected. Developer Preview +// the Chat API still validates the query syntax with service accounts, +// so invalid queries are still rejected. Developer Preview // (https://developers.google.com/workspace/preview). func (c *SpacesListCall) Filter(filter string) *SpacesListCall { c.urlParams_.Set("filter", filter) @@ -5888,20 +5914,20 @@ func (c *SpacesListCall) Filter(filter string) *SpacesListCall { } // PageSize sets the optional parameter "pageSize": 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; values above 1000 are coerced to 1000. Negative values return -// an `INVALID_ARGUMENT` error. +// of spaces to return. The service might return fewer than this value. +// If unspecified, at most 100 spaces are returned. The maximum value is +// 1,000. If you use a value more than 1,000, it's automatically changed +// to 1,000. Negative values return an `INVALID_ARGUMENT` error. func (c *SpacesListCall) PageSize(pageSize int64) *SpacesListCall { c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) return c } // PageToken sets the optional parameter "pageToken": A page token, -// received from a previous list spaces 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 may -// lead to unexpected results. +// 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. func (c *SpacesListCall) PageToken(pageToken string) *SpacesListCall { c.urlParams_.Set("pageToken", pageToken) return c @@ -6010,18 +6036,18 @@ func (c *SpacesListCall) Do(opts ...googleapi.CallOption) (*ListSpacesResponse, // "parameterOrder": [], // "parameters": { // "filter": { - // "description": "Optional. A query filter. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). You can filter spaces by the space type ([`space_type`](https://developers.google.com/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` cannot 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. With [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), this field is ignored and the query always returns all spaces. But Chat API still validates the query syntax with service accounts, so invalid queries are still rejected. [Developer Preview](https://developers.google.com/workspace/preview).", + // "description": "Optional. A query filter. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). You can filter spaces by the space type ([`space_type`](https://developers.google.com/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. With [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), this field is ignored and the query always returns all spaces. But the Chat API still validates the query syntax with service accounts, so invalid queries are still rejected. [Developer Preview](https://developers.google.com/workspace/preview).", // "location": "query", // "type": "string" // }, // "pageSize": { - // "description": "Optional. 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; values above 1000 are coerced to 1000. Negative values return an `INVALID_ARGUMENT` error.", + // "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 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "description": "Optional. A page token, received from a previous list spaces 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 may lead to unexpected results.", + // "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.", // "location": "query", // "type": "string" // } @@ -6077,7 +6103,7 @@ type SpacesPatchCall struct { // (https://developers.google.com/chat/api/guides/auth/users) and the // `chat.spaces` scope. // -// - name: Resource name of the space. Format: spaces/{space}. +// - name: Resource name of the space. Format: `spaces/{space}`. func (r *SpacesService) Patch(name string, space *Space) *SpacesPatchCall { c := &SpacesPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -6086,23 +6112,23 @@ func (r *SpacesService) Patch(name string, space *Space) *SpacesPatchCall { } // UpdateMask sets the optional parameter "updateMask": Required. The -// field paths to be updated, comma separated if there are multiple. -// Currently supported field paths: - display_name (Only supports -// changing the display name of a space with the SPACE type, or when -// also including the `space_type` mask to change a GROUP_CHAT space -// type to SPACE. Trying to update the display name of a GROUP_CHAT or a -// DIRECT_MESSAGE space results in an invalid argument error.) - -// 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_details - space_history_state (Supports turning -// history on or off for the space -// (https://support.google.com/chat/answer/7664687) if the organization -// allows users to change their history setting +// updated field paths, comma separated if there are multiple. Currently +// supported field paths: - `display_name` (Only supports changing the +// display name of a space with the `SPACE` type, or when also including +// the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. +// Trying to update the display name of a `GROUP_CHAT` or a +// `DIRECT_MESSAGE` space results in an invalid argument error.) - +// `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_details` - +// `space_history_state` (Supports turning history on or off for the +// space (https://support.google.com/chat/answer/7664687) if the +// organization allows users to change their history setting // (https://support.google.com/a/answer/7664184). Warning: mutually // exclusive with all other field paths.) func (c *SpacesPatchCall) UpdateMask(updateMask string) *SpacesPatchCall { @@ -6210,14 +6236,14 @@ func (c *SpacesPatchCall) Do(opts ...googleapi.CallOption) (*Space, error) { // ], // "parameters": { // "name": { - // "description": "Resource name of the space. Format: spaces/{space}", + // "description": "Resource name of the space. Format: `spaces/{space}`", // "location": "path", // "pattern": "^spaces/[^/]+$", // "required": true, // "type": "string" // }, // "updateMask": { - // "description": "Required. The field paths to be updated, comma separated if there are multiple. Currently supported field paths: - display_name (Only supports changing the display name of a space with the SPACE type, or when also including the `space_type` mask to change a GROUP_CHAT space type to SPACE. Trying to update the display name of a GROUP_CHAT or a DIRECT_MESSAGE space results in an invalid argument error.) - 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_details - space_history_state (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.)", + // "description": "Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument error.) - `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_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.)", // "format": "google-fieldmask", // "location": "query", // "type": "string" @@ -6274,7 +6300,7 @@ type SpacesSetupCall struct { // (https://developers.google.com/chat/api/reference/rest/v1/spaces.members/create) // 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 or guest access are not +// returned. Spaces with threaded replies or guest access aren't // supported. Requires user authentication // (https://developers.google.com/chat/api/guides/auth/users) and the // `chat.spaces.create` or `chat.spaces` scope. @@ -6372,7 +6398,7 @@ func (c *SpacesSetupCall) Do(opts ...googleapi.CallOption) (*Space, error) { } return ret, nil // { - // "description": "[Developer Preview](https://developers.google.com/workspace/preview): 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. To specify the human members to add, add memberships with the appropriate `member.name` in the `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` is either the `{person_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 Admin SDK Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`, you can add the user to the space by including a membership with `users/123456789` as the `member.name`. For a space or group chat, if the caller blocks or is blocked by 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 add app memberships to DMs. To add the calling app as a member of other space types, use [create membership](https://developers.google.com/chat/api/reference/rest/v1/spaces.members/create) 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 or guest access are not supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.", + // "description": "[Developer Preview](https://developers.google.com/workspace/preview): 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. To specify the human members to add, add memberships with the appropriate `member.name` in the `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` is either the `{person_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 Admin SDK Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`, you can add the user to the space by including a membership with `users/123456789` as the `member.name`. For a space or group chat, if the caller blocks or is blocked by 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 add app memberships to DMs. To add the calling app as a member of other space types, use [create membership](https://developers.google.com/chat/api/reference/rest/v1/spaces.members/create) 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 or guest access aren't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.", // "flatPath": "v1/spaces:setup", // "httpMethod": "POST", // "id": "chat.spaces.setup", @@ -6407,7 +6433,7 @@ type SpacesMembersCreateCall struct { // Create: Developer Preview // (https://developers.google.com/workspace/preview): Creates a human // membership or app membership for the calling app. Creating -// memberships for other apps is not supported. Requires user +// memberships for other apps isn't supported. Requires user // authentication // (https://developers.google.com/chat/api/guides/auth/users) and the // `chat.memberships` (for human membership) or `chat.memberships.app` @@ -6418,10 +6444,9 @@ type SpacesMembersCreateCall struct { // 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 Admin SDK Directory API. For example, if the People API -// `Person` `resourceName` is `people/123456789`, the user can be added -// to the space by setting the `membership.member.name` to -// `users/123456789`. +// in the Directory API. For example, if the People API `Person` +// `resourceName` is `people/123456789`, you can add the user to the +// space by setting the `membership.member.name` to `users/123456789`. // // - parent: The resource name of the space for which to create the // membership. Format: spaces/{space}. @@ -6523,7 +6548,7 @@ func (c *SpacesMembersCreateCall) Do(opts ...googleapi.CallOption) (*Membership, } return ret, nil // { - // "description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a human membership or app membership for the calling app. Creating memberships for other apps is not supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.memberships` (for human membership) or `chat.memberships.app` (for app membership) scope. To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to the space, use `users/app`. - To add a human user, use `users/{user}`, where `{user}` is either the `{person_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 Admin SDK Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`, the user can be added to the space by setting the `membership.member.name` to `users/123456789`.", + // "description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.memberships` (for human membership) or `chat.memberships.app` (for app membership) scope. To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to the space, use `users/app`. - To add a human user, use `users/{user}`, where `{user}` is either the `{person_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 `Person` `resourceName` is `people/123456789`, you can add the user to the space by setting the `membership.member.name` to `users/123456789`.", // "flatPath": "v1/spaces/{spacesId}/members", // "httpMethod": "POST", // "id": "chat.spaces.members.create", @@ -6577,7 +6602,7 @@ type SpacesMembersDeleteCall struct { // `spaces/{space}/members/{member}` format. 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. +// `spaces/{space}/members/{member}` or `spaces/{space}/members/app`. func (r *SpacesMembersService) Delete(name string) *SpacesMembersDeleteCall { c := &SpacesMembersDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -6679,7 +6704,7 @@ func (c *SpacesMembersDeleteCall) Do(opts ...googleapi.CallOption) (*Membership, // ], // "parameters": { // "name": { - // "description": "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 and `spaces/{space}/members/{member}` format. 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", + // "description": "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 and `spaces/{space}/members/{member}` format. 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`", // "location": "path", // "pattern": "^spaces/[^/]+/members/[^/]+$", // "required": true, @@ -6723,7 +6748,7 @@ type SpacesMembersGetCall struct { // scope. // // - name: Resource name of the membership to retrieve. Format: -// spaces/{space}/members/{member}. +// `spaces/{space}/members/{member}`. func (r *SpacesMembersService) Get(name string) *SpacesMembersGetCall { c := &SpacesMembersGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -6838,7 +6863,7 @@ func (c *SpacesMembersGetCall) Do(opts ...googleapi.CallOption) (*Membership, er // ], // "parameters": { // "name": { - // "description": "Required. Resource name of the membership to retrieve. Format: spaces/{space}/members/{member}", + // "description": "Required. Resource name of the membership to retrieve. Format: `spaces/{space}/members/{member}`", // "location": "path", // "pattern": "^spaces/[^/]+/members/[^/]+$", // "required": true, @@ -6910,21 +6935,22 @@ func (c *SpacesMembersListCall) Filter(filter string) *SpacesMembersListCall { } // PageSize sets the optional parameter "pageSize": The maximum number -// of memberships to return. The service may return fewer than this +// 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; values above 1000 are coerced to 1000. -// Negative values return an INVALID_ARGUMENT error. +// maximum value is 1,000. If you use a value more than 1,000, it's +// automatically changed to 1,000. Negative values return an +// `INVALID_ARGUMENT` error. func (c *SpacesMembersListCall) PageSize(pageSize int64) *SpacesMembersListCall { c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) return c } // PageToken sets the optional parameter "pageToken": A page token, -// received from a previous call to list memberships. 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 may lead to unexpected -// results. +// 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. func (c *SpacesMembersListCall) PageToken(pageToken string) *SpacesMembersListCall { c.urlParams_.Set("pageToken", pageToken) return c @@ -7054,13 +7080,13 @@ func (c *SpacesMembersListCall) Do(opts ...googleapi.CallOption) (*ListMembershi // "type": "string" // }, // "pageSize": { - // "description": "The maximum number of memberships to return. The service may return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000; values above 1000 are coerced to 1000. Negative values return an INVALID_ARGUMENT error.", + // "description": "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 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "description": "A page token, received from a previous call to list memberships. 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 may lead to unexpected results.", + // "description": "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.", // "location": "query", // "type": "string" // }, @@ -7141,7 +7167,7 @@ type SpacesMessagesCreateCall struct { // create messages without a service account or user authentication. // // - parent: The resource name of the space in which to create a -// message. Format: spaces/{space}. +// message. Format: `spaces/{space}`. func (r *SpacesMessagesService) Create(parent string, message *Message) *SpacesMessagesCreateCall { c := &SpacesMessagesCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -7170,13 +7196,13 @@ func (c *SpacesMessagesCreateCall) MessageId(messageId string) *SpacesMessagesCr // "MESSAGE_REPLY_OPTION_UNSPECIFIED" - Default. Starts a thread. // "REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD" - Creates the message as a // -// reply to the thread specified by thread ID or thread_key. If it +// reply to the thread specified by thread ID or `thread_key`. If it // fails, the message starts a new thread instead. // // "REPLY_MESSAGE_OR_FAIL" - Creates the message as a reply to the // -// thread specified by thread ID or thread_key. If it fails, a NOT_FOUND -// error is returned instead. +// thread specified by thread ID or `thread_key`. If it fails, a +// `NOT_FOUND` error is returned instead. func (c *SpacesMessagesCreateCall) MessageReplyOption(messageReplyOption string) *SpacesMessagesCreateCall { c.urlParams_.Set("messageReplyOption", messageReplyOption) return c @@ -7314,14 +7340,14 @@ func (c *SpacesMessagesCreateCall) Do(opts ...googleapi.CallOption) (*Message, e // ], // "enumDescriptions": [ // "Default. Starts a thread.", - // "Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, the message starts a new thread instead.", - // "Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, a NOT_FOUND error is returned instead." + // "Creates the message as a reply to the thread specified by thread ID or `thread_key`. If it fails, the message starts a new thread instead.", + // "Creates the message as a reply to the thread specified by thread ID or `thread_key`. If it fails, a `NOT_FOUND` error is returned instead." // ], // "location": "query", // "type": "string" // }, // "parent": { - // "description": "Required. The resource name of the space in which to create a message. Format: spaces/{space}", + // "description": "Required. The resource name of the space in which to create a message. Format: `spaces/{space}`", // "location": "path", // "pattern": "^spaces/[^/]+$", // "required": true, @@ -7378,9 +7404,9 @@ type SpacesMessagesDeleteCall struct { // (https://developers.google.com/chat/api/guides/auth/users) requires // the `chat.messages` authorization scope. // -// - name: Resource name of the message to be deleted, in the form -// "spaces/*/messages/*" Example: -// spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB. +// - name: Resource name of the message that you want to delete, in the +// form `spaces/*/messages/*` Example: +// `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. func (r *SpacesMessagesService) Delete(name string) *SpacesMessagesDeleteCall { c := &SpacesMessagesDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -7499,7 +7525,7 @@ func (c *SpacesMessagesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, err // "type": "boolean" // }, // "name": { - // "description": "Required. Resource name of the message to be deleted, in the form \"spaces/*/messages/*\" Example: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB", + // "description": "Required. Resource name of the message that you want to delete, in the form `spaces/*/messages/*` Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`", // "location": "path", // "pattern": "^spaces/[^/]+/messages/[^/]+$", // "required": true, @@ -7545,7 +7571,7 @@ type SpacesMessagesGetCall struct { // Note: Might return a message from a blocked member or space. // // - name: Resource name of the message to retrieve. Format: -// spaces/{space}/messages/{message} If the message begins with +// `spaces/{space}/messages/{message}` If the message begins with // `client-`, then it has a custom name assigned by a Chat app that // created it with the Chat REST API. That Chat app (but not others) // can pass the custom name to get, update, or delete the message. To @@ -7665,7 +7691,7 @@ func (c *SpacesMessagesGetCall) Do(opts ...googleapi.CallOption) (*Message, erro // ], // "parameters": { // "name": { - // "description": "Required. Resource name of the message to retrieve. Format: spaces/{space}/messages/{message} If the message begins with `client-`, then it has a custom name assigned by a Chat app that created it with the Chat REST API. That Chat app (but not others) can pass the custom name to get, update, or delete the message. To learn more, see [create and name a message] (https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).", + // "description": "Required. Resource name of the message to retrieve. Format: `spaces/{space}/messages/{message}` If the message begins with `client-`, then it has a custom name assigned by a Chat app that created it with the Chat REST API. That Chat app (but not others) can pass the custom name to get, update, or delete the message. To learn more, see [create and name a message] (https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).", // "location": "path", // "pattern": "^spaces/[^/]+/messages/[^/]+$", // "required": true, @@ -7706,7 +7732,7 @@ type SpacesMessagesListCall struct { // outside the Workspace organization to join. // // - parent: The resource name of the space to list messages from. -// Format: spaces/{space}. +// Format: `spaces/{space}`. func (r *SpacesMessagesService) List(parent string) *SpacesMessagesListCall { c := &SpacesMessagesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -7742,19 +7768,20 @@ func (c *SpacesMessagesListCall) Filter(filter string) *SpacesMessagesListCall { // OrderBy sets the optional parameter "orderBy": Optional, if resuming // from a previous query. How the list of messages is ordered. Specify a -// value to order by and an ordering operation. Valid ordering operation -// values are: - `ASC` for ascending. - `DESC` for descending. The -// default ordering is `create_time ASC`. +// 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`. func (c *SpacesMessagesListCall) OrderBy(orderBy string) *SpacesMessagesListCall { c.urlParams_.Set("orderBy", orderBy) return c } // PageSize sets the optional parameter "pageSize": The maximum number -// of messages returned. The service may return fewer messages than this -// value. If unspecified, at most 25 are returned. The maximum value is -// 1000; values above 1000 are coerced to 1000. Negative values return -// an `INVALID_ARGUMENT` error. +// of messages returned. The service might return fewer messages than +// this value. If unspecified, at most 25 are returned. The maximum +// value is 1,000. If you use a value more than 1,000, it's +// automatically changed to 1,000. Negative values return an +// `INVALID_ARGUMENT` error. func (c *SpacesMessagesListCall) PageSize(pageSize int64) *SpacesMessagesListCall { c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) return c @@ -7762,10 +7789,10 @@ func (c *SpacesMessagesListCall) PageSize(pageSize int64) *SpacesMessagesListCal // PageToken sets the optional parameter "pageToken": Optional, if // resuming from a previous query. A page token received from a previous -// list messages 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 may lead to unexpected results. +// 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. func (c *SpacesMessagesListCall) PageToken(pageToken string) *SpacesMessagesListCall { c.urlParams_.Set("pageToken", pageToken) return c @@ -7892,23 +7919,23 @@ func (c *SpacesMessagesListCall) Do(opts ...googleapi.CallOption) (*ListMessages // "type": "string" // }, // "orderBy": { - // "description": "Optional, if resuming from a previous query. How the list of messages is ordered. Specify a value to order by and an ordering operation. Valid ordering operation values are: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.", + // "description": "Optional, if resuming from a previous query. 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`.", // "location": "query", // "type": "string" // }, // "pageSize": { - // "description": "The maximum number of messages returned. The service may return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000; values above 1000 are coerced to 1000. Negative values return an `INVALID_ARGUMENT` error.", + // "description": "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 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "description": "Optional, if resuming from a previous query. A page token received from a previous list messages 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 may lead to unexpected results.", + // "description": "Optional, if resuming from a previous query. 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.", // "location": "query", // "type": "string" // }, // "parent": { - // "description": "Required. The resource name of the space to list messages from. Format: spaces/{space}", + // "description": "Required. The resource name of the space to list messages from. Format: `spaces/{space}`", // "location": "path", // "pattern": "^spaces/[^/]+$", // "required": true, @@ -7991,7 +8018,7 @@ func (r *SpacesMessagesService) Patch(name string, message *Message) *SpacesMess } // AllowMissing sets the optional parameter "allowMissing": If `true` -// and the message is not found, a new message is created and +// 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/chat/api/guides/crudl/messages#name_a_created_message) @@ -8003,9 +8030,9 @@ func (c *SpacesMessagesPatchCall) AllowMissing(allowMissing bool) *SpacesMessage // UpdateMask sets the optional parameter "updateMask": Required. The // field paths to update. Separate multiple values with commas. -// Currently supported field paths: - text - cards (Requires service +// Currently supported field paths: - `text` - `cards` (Requires service // account authentication (/chat/api/guides/auth/service-accounts).) - -// cards_v2 +// `cards_v2` func (c *SpacesMessagesPatchCall) UpdateMask(updateMask string) *SpacesMessagesPatchCall { c.urlParams_.Set("updateMask", updateMask) return c @@ -8111,7 +8138,7 @@ func (c *SpacesMessagesPatchCall) Do(opts ...googleapi.CallOption) (*Message, er // ], // "parameters": { // "allowMissing": { - // "description": "Optional. If `true` and the message is not found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.", + // "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/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.", // "location": "query", // "type": "boolean" // }, @@ -8123,7 +8150,7 @@ func (c *SpacesMessagesPatchCall) Do(opts ...googleapi.CallOption) (*Message, er // "type": "string" // }, // "updateMask": { - // "description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - cards_v2 ", + // "description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` ", // "format": "google-fieldmask", // "location": "query", // "type": "string" @@ -8182,7 +8209,7 @@ func (r *SpacesMessagesService) Update(name string, message *Message) *SpacesMes } // AllowMissing sets the optional parameter "allowMissing": If `true` -// and the message is not found, a new message is created and +// 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/chat/api/guides/crudl/messages#name_a_created_message) @@ -8194,9 +8221,9 @@ func (c *SpacesMessagesUpdateCall) AllowMissing(allowMissing bool) *SpacesMessag // UpdateMask sets the optional parameter "updateMask": Required. The // field paths to update. Separate multiple values with commas. -// Currently supported field paths: - text - cards (Requires service +// Currently supported field paths: - `text` - `cards` (Requires service // account authentication (/chat/api/guides/auth/service-accounts).) - -// cards_v2 +// `cards_v2` func (c *SpacesMessagesUpdateCall) UpdateMask(updateMask string) *SpacesMessagesUpdateCall { c.urlParams_.Set("updateMask", updateMask) return c @@ -8302,7 +8329,7 @@ func (c *SpacesMessagesUpdateCall) Do(opts ...googleapi.CallOption) (*Message, e // ], // "parameters": { // "allowMissing": { - // "description": "Optional. If `true` and the message is not found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.", + // "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/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.", // "location": "query", // "type": "boolean" // }, @@ -8314,7 +8341,7 @@ func (c *SpacesMessagesUpdateCall) Do(opts ...googleapi.CallOption) (*Message, e // "type": "string" // }, // "updateMask": { - // "description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - cards_v2 ", + // "description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` ", // "format": "google-fieldmask", // "location": "query", // "type": "string" @@ -8353,7 +8380,7 @@ type SpacesMessagesAttachmentsGetCall struct { // (https://developers.google.com/chat/api/guides/auth/service-accounts). // // - name: Resource name of the attachment, in the form -// "spaces/*/messages/*/attachments/*". +// `spaces/*/messages/*/attachments/*`. func (r *SpacesMessagesAttachmentsService) Get(name string) *SpacesMessagesAttachmentsGetCall { c := &SpacesMessagesAttachmentsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -8468,7 +8495,7 @@ func (c *SpacesMessagesAttachmentsGetCall) Do(opts ...googleapi.CallOption) (*At // ], // "parameters": { // "name": { - // "description": "Required. Resource name of the attachment, in the form \"spaces/*/messages/*/attachments/*\".", + // "description": "Required. Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.", // "location": "path", // "pattern": "^spaces/[^/]+/messages/[^/]+/attachments/[^/]+$", // "required": true, @@ -8506,7 +8533,7 @@ type SpacesMessagesReactionsCreateCall struct { // supported. // // - parent: The message where the reaction is created. Format: -// spaces/{space}/messages/{message}. +// `spaces/{space}/messages/{message}`. func (r *SpacesMessagesReactionsService) Create(parent string, reaction *Reaction) *SpacesMessagesReactionsCreateCall { c := &SpacesMessagesReactionsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -8614,7 +8641,7 @@ func (c *SpacesMessagesReactionsCreateCall) Do(opts ...googleapi.CallOption) (*R // ], // "parameters": { // "parent": { - // "description": "Required. The message where the reaction is created. Format: spaces/{space}/messages/{message}", + // "description": "Required. The message where the reaction is created. Format: `spaces/{space}/messages/{message}`", // "location": "path", // "pattern": "^spaces/[^/]+/messages/[^/]+$", // "required": true, @@ -8654,7 +8681,7 @@ type SpacesMessagesReactionsDeleteCall struct { // `chat.messages` or `chat.messages.reactions` scope. // // - name: Name of the reaction to delete. Format: -// spaces/{space}/messages/{message}/reactions/{reaction}. +// `spaces/{space}/messages/{message}/reactions/{reaction}`. func (r *SpacesMessagesReactionsService) Delete(name string) *SpacesMessagesReactionsDeleteCall { c := &SpacesMessagesReactionsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -8756,7 +8783,7 @@ func (c *SpacesMessagesReactionsDeleteCall) Do(opts ...googleapi.CallOption) (*E // ], // "parameters": { // "name": { - // "description": "Required. Name of the reaction to delete. Format: spaces/{space}/messages/{message}/reactions/{reaction}", + // "description": "Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`", // "location": "path", // "pattern": "^spaces/[^/]+/messages/[^/]+/reactions/[^/]+$", // "required": true, @@ -8794,7 +8821,7 @@ type SpacesMessagesReactionsListCall struct { // or `chat.messages.reactions.readonly` scope. // // - parent: The message users reacted to. Format: -// spaces/{space}/messages/{message}. +// `spaces/{space}/messages/{message}`. func (r *SpacesMessagesReactionsService) List(parent string) *SpacesMessagesReactionsListCall { c := &SpacesMessagesReactionsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -8832,7 +8859,7 @@ func (c *SpacesMessagesReactionsListCall) Filter(filter string) *SpacesMessagesR } // PageSize sets the optional parameter "pageSize": The maximum number -// of reactions returned. The service may return fewer reactions than +// 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. func (c *SpacesMessagesReactionsListCall) PageSize(pageSize int64) *SpacesMessagesReactionsListCall { @@ -8844,7 +8871,8 @@ func (c *SpacesMessagesReactionsListCall) PageSize(pageSize int64) *SpacesMessag // 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 may lead to unexpected results. +// page token. Passing a different value might lead to unexpected +// results. func (c *SpacesMessagesReactionsListCall) PageToken(pageToken string) *SpacesMessagesReactionsListCall { c.urlParams_.Set("pageToken", pageToken) return c @@ -8963,18 +8991,18 @@ func (c *SpacesMessagesReactionsListCall) Do(opts ...googleapi.CallOption) (*Lis // "type": "string" // }, // "pageSize": { - // "description": "Optional. The maximum number of reactions returned. The service may 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.", + // "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", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "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 may lead to unexpected results.", + // "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.", // "location": "query", // "type": "string" // }, // "parent": { - // "description": "Required. The message users reacted to. Format: spaces/{space}/messages/{message}", + // "description": "Required. The message users reacted to. Format: `spaces/{space}/messages/{message}`", // "location": "path", // "pattern": "^spaces/[^/]+/messages/[^/]+$", // "required": true, diff --git a/cloudfunctions/v1/cloudfunctions-api.json b/cloudfunctions/v1/cloudfunctions-api.json index 2211495adff..ae809131bdc 100644 --- a/cloudfunctions/v1/cloudfunctions-api.json +++ b/cloudfunctions/v1/cloudfunctions-api.json @@ -546,7 +546,7 @@ } } }, - "revision": "20230504", + "revision": "20230515", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -964,6 +964,30 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2LocationMetadata": { + "description": "Extra GCF specific location information.", + "id": "GoogleCloudFunctionsV2LocationMetadata", + "properties": { + "environments": { + "description": "The Cloud Function environments this location supports.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2OperationMetadata", @@ -1111,6 +1135,30 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2alphaLocationMetadata": { + "description": "Extra GCF specific location information.", + "id": "GoogleCloudFunctionsV2alphaLocationMetadata", + "properties": { + "environments": { + "description": "The Cloud Function environments this location supports.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2alphaOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2alphaOperationMetadata", @@ -1258,6 +1306,30 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2betaLocationMetadata": { + "description": "Extra GCF specific location information.", + "id": "GoogleCloudFunctionsV2betaLocationMetadata", + "properties": { + "environments": { + "description": "The Cloud Function environments this location supports.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2betaOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2betaOperationMetadata", diff --git a/cloudfunctions/v1/cloudfunctions-gen.go b/cloudfunctions/v1/cloudfunctions-gen.go index 4a3b68df0d1..b766be00d27 100644 --- a/cloudfunctions/v1/cloudfunctions-gen.go +++ b/cloudfunctions/v1/cloudfunctions-gen.go @@ -992,6 +992,40 @@ func (s *GenerateUploadUrlResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudFunctionsV2LocationMetadata: Extra GCF specific location +// information. +type GoogleCloudFunctionsV2LocationMetadata struct { + // Environments: The Cloud Function environments this location supports. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Unspecified + // "GEN_1" - Gen 1 + // "GEN_2" - Gen 2 + Environments []string `json:"environments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Environments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Environments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudFunctionsV2LocationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudFunctionsV2LocationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudFunctionsV2OperationMetadata: Represents the metadata of // the long-running operation. type GoogleCloudFunctionsV2OperationMetadata struct { @@ -1147,6 +1181,40 @@ func (s *GoogleCloudFunctionsV2StateMessage) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudFunctionsV2alphaLocationMetadata: Extra GCF specific +// location information. +type GoogleCloudFunctionsV2alphaLocationMetadata struct { + // Environments: The Cloud Function environments this location supports. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Unspecified + // "GEN_1" - Gen 1 + // "GEN_2" - Gen 2 + Environments []string `json:"environments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Environments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Environments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudFunctionsV2alphaLocationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudFunctionsV2alphaLocationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudFunctionsV2alphaOperationMetadata: Represents the metadata // of the long-running operation. type GoogleCloudFunctionsV2alphaOperationMetadata struct { @@ -1303,6 +1371,40 @@ func (s *GoogleCloudFunctionsV2alphaStateMessage) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudFunctionsV2betaLocationMetadata: Extra GCF specific +// location information. +type GoogleCloudFunctionsV2betaLocationMetadata struct { + // Environments: The Cloud Function environments this location supports. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Unspecified + // "GEN_1" - Gen 1 + // "GEN_2" - Gen 2 + Environments []string `json:"environments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Environments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Environments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudFunctionsV2betaLocationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudFunctionsV2betaLocationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudFunctionsV2betaOperationMetadata: Represents the metadata // of the long-running operation. type GoogleCloudFunctionsV2betaOperationMetadata struct { diff --git a/cloudfunctions/v2/cloudfunctions-api.json b/cloudfunctions/v2/cloudfunctions-api.json index 83006b7f9d5..231f501b647 100644 --- a/cloudfunctions/v2/cloudfunctions-api.json +++ b/cloudfunctions/v2/cloudfunctions-api.json @@ -571,7 +571,7 @@ } } }, - "revision": "20230420", + "revision": "20230515", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -927,6 +927,30 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2LocationMetadata": { + "description": "Extra GCF specific location information.", + "id": "GoogleCloudFunctionsV2LocationMetadata", + "properties": { + "environments": { + "description": "The Cloud Function environments this location supports.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2OperationMetadata", @@ -1074,6 +1098,30 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2alphaLocationMetadata": { + "description": "Extra GCF specific location information.", + "id": "GoogleCloudFunctionsV2alphaLocationMetadata", + "properties": { + "environments": { + "description": "The Cloud Function environments this location supports.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2alphaOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2alphaOperationMetadata", @@ -1221,6 +1269,30 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2betaLocationMetadata": { + "description": "Extra GCF specific location information.", + "id": "GoogleCloudFunctionsV2betaLocationMetadata", + "properties": { + "environments": { + "description": "The Cloud Function environments this location supports.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2betaOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2betaOperationMetadata", diff --git a/cloudfunctions/v2/cloudfunctions-gen.go b/cloudfunctions/v2/cloudfunctions-gen.go index bbc91c33835..e9ab7b58ae0 100644 --- a/cloudfunctions/v2/cloudfunctions-gen.go +++ b/cloudfunctions/v2/cloudfunctions-gen.go @@ -856,6 +856,40 @@ func (s *GenerateUploadUrlResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudFunctionsV2LocationMetadata: Extra GCF specific location +// information. +type GoogleCloudFunctionsV2LocationMetadata struct { + // Environments: The Cloud Function environments this location supports. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Unspecified + // "GEN_1" - Gen 1 + // "GEN_2" - Gen 2 + Environments []string `json:"environments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Environments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Environments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudFunctionsV2LocationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudFunctionsV2LocationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudFunctionsV2OperationMetadata: Represents the metadata of // the long-running operation. type GoogleCloudFunctionsV2OperationMetadata struct { @@ -1011,6 +1045,40 @@ func (s *GoogleCloudFunctionsV2StateMessage) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudFunctionsV2alphaLocationMetadata: Extra GCF specific +// location information. +type GoogleCloudFunctionsV2alphaLocationMetadata struct { + // Environments: The Cloud Function environments this location supports. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Unspecified + // "GEN_1" - Gen 1 + // "GEN_2" - Gen 2 + Environments []string `json:"environments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Environments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Environments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudFunctionsV2alphaLocationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudFunctionsV2alphaLocationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudFunctionsV2alphaOperationMetadata: Represents the metadata // of the long-running operation. type GoogleCloudFunctionsV2alphaOperationMetadata struct { @@ -1167,6 +1235,40 @@ func (s *GoogleCloudFunctionsV2alphaStateMessage) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudFunctionsV2betaLocationMetadata: Extra GCF specific +// location information. +type GoogleCloudFunctionsV2betaLocationMetadata struct { + // Environments: The Cloud Function environments this location supports. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Unspecified + // "GEN_1" - Gen 1 + // "GEN_2" - Gen 2 + Environments []string `json:"environments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Environments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Environments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudFunctionsV2betaLocationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudFunctionsV2betaLocationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudFunctionsV2betaOperationMetadata: Represents the metadata // of the long-running operation. type GoogleCloudFunctionsV2betaOperationMetadata struct { diff --git a/cloudfunctions/v2alpha/cloudfunctions-api.json b/cloudfunctions/v2alpha/cloudfunctions-api.json index eb80ff0a6e3..0aa502cbb51 100644 --- a/cloudfunctions/v2alpha/cloudfunctions-api.json +++ b/cloudfunctions/v2alpha/cloudfunctions-api.json @@ -571,7 +571,7 @@ } } }, - "revision": "20230420", + "revision": "20230515", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -927,6 +927,30 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2LocationMetadata": { + "description": "Extra GCF specific location information.", + "id": "GoogleCloudFunctionsV2LocationMetadata", + "properties": { + "environments": { + "description": "The Cloud Function environments this location supports.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2OperationMetadata", @@ -1074,6 +1098,30 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2alphaLocationMetadata": { + "description": "Extra GCF specific location information.", + "id": "GoogleCloudFunctionsV2alphaLocationMetadata", + "properties": { + "environments": { + "description": "The Cloud Function environments this location supports.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2alphaOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2alphaOperationMetadata", @@ -1221,6 +1269,30 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2betaLocationMetadata": { + "description": "Extra GCF specific location information.", + "id": "GoogleCloudFunctionsV2betaLocationMetadata", + "properties": { + "environments": { + "description": "The Cloud Function environments this location supports.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2betaOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2betaOperationMetadata", diff --git a/cloudfunctions/v2alpha/cloudfunctions-gen.go b/cloudfunctions/v2alpha/cloudfunctions-gen.go index 8b8289a4e8c..ccb010fd43c 100644 --- a/cloudfunctions/v2alpha/cloudfunctions-gen.go +++ b/cloudfunctions/v2alpha/cloudfunctions-gen.go @@ -856,6 +856,40 @@ func (s *GenerateUploadUrlResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudFunctionsV2LocationMetadata: Extra GCF specific location +// information. +type GoogleCloudFunctionsV2LocationMetadata struct { + // Environments: The Cloud Function environments this location supports. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Unspecified + // "GEN_1" - Gen 1 + // "GEN_2" - Gen 2 + Environments []string `json:"environments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Environments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Environments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudFunctionsV2LocationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudFunctionsV2LocationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudFunctionsV2OperationMetadata: Represents the metadata of // the long-running operation. type GoogleCloudFunctionsV2OperationMetadata struct { @@ -1011,6 +1045,40 @@ func (s *GoogleCloudFunctionsV2StateMessage) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudFunctionsV2alphaLocationMetadata: Extra GCF specific +// location information. +type GoogleCloudFunctionsV2alphaLocationMetadata struct { + // Environments: The Cloud Function environments this location supports. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Unspecified + // "GEN_1" - Gen 1 + // "GEN_2" - Gen 2 + Environments []string `json:"environments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Environments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Environments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudFunctionsV2alphaLocationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudFunctionsV2alphaLocationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudFunctionsV2alphaOperationMetadata: Represents the metadata // of the long-running operation. type GoogleCloudFunctionsV2alphaOperationMetadata struct { @@ -1167,6 +1235,40 @@ func (s *GoogleCloudFunctionsV2alphaStateMessage) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudFunctionsV2betaLocationMetadata: Extra GCF specific +// location information. +type GoogleCloudFunctionsV2betaLocationMetadata struct { + // Environments: The Cloud Function environments this location supports. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Unspecified + // "GEN_1" - Gen 1 + // "GEN_2" - Gen 2 + Environments []string `json:"environments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Environments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Environments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudFunctionsV2betaLocationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudFunctionsV2betaLocationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudFunctionsV2betaOperationMetadata: Represents the metadata // of the long-running operation. type GoogleCloudFunctionsV2betaOperationMetadata struct { diff --git a/cloudfunctions/v2beta/cloudfunctions-api.json b/cloudfunctions/v2beta/cloudfunctions-api.json index d71520bc850..4cf1db0d730 100644 --- a/cloudfunctions/v2beta/cloudfunctions-api.json +++ b/cloudfunctions/v2beta/cloudfunctions-api.json @@ -571,7 +571,7 @@ } } }, - "revision": "20230420", + "revision": "20230515", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -927,6 +927,30 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2LocationMetadata": { + "description": "Extra GCF specific location information.", + "id": "GoogleCloudFunctionsV2LocationMetadata", + "properties": { + "environments": { + "description": "The Cloud Function environments this location supports.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2OperationMetadata", @@ -1074,6 +1098,30 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2alphaLocationMetadata": { + "description": "Extra GCF specific location information.", + "id": "GoogleCloudFunctionsV2alphaLocationMetadata", + "properties": { + "environments": { + "description": "The Cloud Function environments this location supports.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2alphaOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2alphaOperationMetadata", @@ -1221,6 +1269,30 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2betaLocationMetadata": { + "description": "Extra GCF specific location information.", + "id": "GoogleCloudFunctionsV2betaLocationMetadata", + "properties": { + "environments": { + "description": "The Cloud Function environments this location supports.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2betaOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2betaOperationMetadata", diff --git a/cloudfunctions/v2beta/cloudfunctions-gen.go b/cloudfunctions/v2beta/cloudfunctions-gen.go index 1e73941d077..f5c91c568a4 100644 --- a/cloudfunctions/v2beta/cloudfunctions-gen.go +++ b/cloudfunctions/v2beta/cloudfunctions-gen.go @@ -856,6 +856,40 @@ func (s *GenerateUploadUrlResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudFunctionsV2LocationMetadata: Extra GCF specific location +// information. +type GoogleCloudFunctionsV2LocationMetadata struct { + // Environments: The Cloud Function environments this location supports. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Unspecified + // "GEN_1" - Gen 1 + // "GEN_2" - Gen 2 + Environments []string `json:"environments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Environments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Environments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudFunctionsV2LocationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudFunctionsV2LocationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudFunctionsV2OperationMetadata: Represents the metadata of // the long-running operation. type GoogleCloudFunctionsV2OperationMetadata struct { @@ -1011,6 +1045,40 @@ func (s *GoogleCloudFunctionsV2StateMessage) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudFunctionsV2alphaLocationMetadata: Extra GCF specific +// location information. +type GoogleCloudFunctionsV2alphaLocationMetadata struct { + // Environments: The Cloud Function environments this location supports. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Unspecified + // "GEN_1" - Gen 1 + // "GEN_2" - Gen 2 + Environments []string `json:"environments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Environments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Environments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudFunctionsV2alphaLocationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudFunctionsV2alphaLocationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudFunctionsV2alphaOperationMetadata: Represents the metadata // of the long-running operation. type GoogleCloudFunctionsV2alphaOperationMetadata struct { @@ -1167,6 +1235,40 @@ func (s *GoogleCloudFunctionsV2alphaStateMessage) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudFunctionsV2betaLocationMetadata: Extra GCF specific +// location information. +type GoogleCloudFunctionsV2betaLocationMetadata struct { + // Environments: The Cloud Function environments this location supports. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Unspecified + // "GEN_1" - Gen 1 + // "GEN_2" - Gen 2 + Environments []string `json:"environments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Environments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Environments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudFunctionsV2betaLocationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudFunctionsV2betaLocationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudFunctionsV2betaOperationMetadata: Represents the metadata // of the long-running operation. type GoogleCloudFunctionsV2betaOperationMetadata struct { diff --git a/cloudsearch/v1/cloudsearch-api.json b/cloudsearch/v1/cloudsearch-api.json index 2b6c8715fea..5d769ff83bb 100644 --- a/cloudsearch/v1/cloudsearch-api.json +++ b/cloudsearch/v1/cloudsearch-api.json @@ -2077,7 +2077,7 @@ } } }, - "revision": "20230321", + "revision": "20230510", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "AbuseReportingConfig": { @@ -2237,6 +2237,35 @@ }, "type": "object" }, + "AddOnFrameStartingState": { + "description": "Starting state for an individual add-on frame.", + "id": "AddOnFrameStartingState", + "properties": { + "additionalData": { + "description": "Additional data internal to the add-on that can be used to initialize itself.", + "type": "string" + }, + "uri": { + "description": "The uri of the artifact being used for an add-on co-activity.", + "type": "string" + } + }, + "type": "object" + }, + "AddOnStartingState": { + "description": "Starting state properties for add-on co-activity.", + "id": "AddOnStartingState", + "properties": { + "addOnFrameStartingStates": { + "additionalProperties": { + "$ref": "AddOnFrameStartingState" + }, + "description": "List of starting state frames for the add-on co-activity. Keys for this map are the values of the AddOnFrameType enum.", + "type": "object" + } + }, + "type": "object" + }, "AddonComposeUiActionMarkup": { "id": "AddonComposeUiActionMarkup", "properties": { @@ -2522,6 +2551,24 @@ }, "type": "object" }, + "AnnotationInfo": { + "description": "Information about the screen annotation session.", + "id": "AnnotationInfo", + "properties": { + "coannotatorDeviceIds": { + "description": "The device resource names of other devices which can annotate the screen.", + "items": { + "type": "string" + }, + "type": "array" + }, + "isActive": { + "description": "Whether the annotation is active.", + "type": "boolean" + } + }, + "type": "object" + }, "AppId": { "description": "Identifier of an App.", "id": "AppId", @@ -2556,7 +2603,8 @@ "CONTACTS_APP", "ACTIVITY_FEED_APP", "DRIVE_APP", - "CHAT_IN_MEET_APP" + "CHAT_IN_MEET_APP", + "SHORTCUT_APP" ], "enumDescriptions": [ "", @@ -2570,6 +2618,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2854,6 +2903,7 @@ "SCAN_RULE_EVALUATION_SKIPPED_NO_RULES_FOUND", "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES_FOR_ACTION_PARAMS", "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES_FOR_TRIGGER", + "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES", "SCAN_RULE_EVALUATION_SKIPPED_CHANGELING_PERMANENT_ERROR", "SCAN_RULE_EVALUATION_SKIPPED_CHANGELING_EMPTY_RESPONSE", "SCAN_RULE_EVALUATION_SKIPPED_UNSUPPORTED_FILE_TYPE", @@ -2881,8 +2931,9 @@ "Scanning was skipped because the message originated from Interop or Babel.", "Scanning was skipped because the message was sent while the space is in migration mode. See go/migration-mode for details.", "Rule fetch happened, but rule evaluation is skipped because no rules were found.", - "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable to the given action params.", - "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable to the given trigger.", + "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable to the given action params. Deprecated. Use SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES", + "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable to the given trigger. Deprecated. Use SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES", + "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable.", "Rule fetch happened, but rule evaluation is skipped because Changeling returned permanent failure while converting the attachment to text.", "Rule fetch happened, but rule evaluation is skipped because Changeling returned an empty response while converting the attachment to text.", "Rule fetch happened, but rule evaluation is skipped because file type is unsupported.", @@ -2897,12 +2948,27 @@ "$ref": "DlpScanSummary", "description": "Summary of a Data Loss Prevention (DLP) scan of the attachment. Attachments are evaluated in the backend when they are uploaded." }, + "experiment": { + "description": "The list of experiments this video is enabled for Next tag: 19", + "items": { + "enum": [ + "UNKNOWN_EXPERIMENT", + "KRONOS_FAST_FORMAT" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "type": "array" + }, "groupId": { "$ref": "GroupId", "description": "GroupId to which this attachment is uploaded." }, "isClientSideTranscodedVideo": { - "description": "If the uploaded file is a video that has been transcoded on the client side Next tag: 18", + "description": "If the uploaded file is a video that has been transcoded on the client side", "type": "boolean" }, "originalDimension": { @@ -3193,8 +3259,8 @@ "FLAT_ROOM", "THREADED_ROOM", "IMMUTABLE_MEMBERSHIP_HUMAN_DM", - "POST_ROOM", - "ACTIVITY_FEED" + "ACTIVITY_FEED", + "SHORTCUT" ], "enumDescriptions": [ "LINT.IfChange", @@ -3204,8 +3270,8 @@ "A flat room that contains a single thread.", "A threaded room. Topics in this room are threaded, and users can reply to any topic.", "A DM with immutable group membership. It can be a 1:1 DM or a group DM with multiple human users.", - "A post room. Topics in this room are organized in a post/reply style. See the design doc for more details: go/PostRoomsInDynamite. Deprecated. Post rooms are no longer supported.", - "Represents an Activity Feed space. These groups are modeled like flat rooms and contain items for users to catch up on important things. Each user should only have one group of this type. See go/activity-feed. Deprecated: The go/activity-feed project is cancelled and this should no longer be used. LINT.ThenChange(//depot/google3/logs/proto/apps_dynamite/dynamite_visual_element_entry.proto:LoggingGroupType,//depot/google3/java/com/google/apps/dynamite/v1/web/ui/group/groups.js:LoggingGroupType)" + "Represents an Activity Feed space. These groups are modeled like flat rooms and contain items for users to catch up on important things. Each user should only have one group of this type. See go/activity-feed. Deprecated: The go/activity-feed project is cancelled and this should no longer be used.", + "Represents a shortcut space. These groups are modeled like flat rooms and contain items for users to catch up on important things such as user mentioned messages and starred messages. LINT.ThenChange(//depot/google3/logs/proto/apps_dynamite/dynamite_visual_element_entry.proto:LoggingGroupType,//depot/google3/java/com/google/apps/dynamite/v1/web/ui/group/groups.js:LoggingGroupType)" ], "type": "string" }, @@ -3549,6 +3615,20 @@ "description": "Required. A globally unique code (e.g. \"cxv-zbgj-wzw\") that points to a meeting space. Note: Meeting codes may be regenerated, which will cause old meeting codes to become invalid.", "type": "string" }, + "meetingType": { + "description": "Required. Type of the meeting. This controls the chat client UX.", + "enum": [ + "MEETING_TYPE_UNSPECIFIED", + "HUDDLE", + "CALL" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, "meetingUrl": { "description": "Required. A URL, in the format \"https://meet.google.com/*\" (e.g. https://meet.google.com/cxv-zbgj-wzw), to identify and access the meeting space.", "type": "string" @@ -3626,6 +3706,20 @@ }, "type": "object" }, + "AppsDynamiteSharedMessageSearchInfo": { + "description": "Metadata used to describe how to render a message in search results page, e.g., highlighting and snipetting. In future, we can use this proto to return more search specific data attached to a message.", + "id": "AppsDynamiteSharedMessageSearchInfo", + "properties": { + "matchedSegmentsInTextBody": { + "description": "An example use case: clients can use this field to highlight matched segments in message text_body defined in http://google3/apps/dynamite/v1/frontend/api/message.proto;l=104;rcl=513400736.", + "items": { + "$ref": "AppsDynamiteSharedTextSegmentsWithDescription" + }, + "type": "array" + } + }, + "type": "object" + }, "AppsDynamiteSharedOrganizationInfo": { "description": "Contains info about the entity that something is, or is owned by.", "id": "AppsDynamiteSharedOrganizationInfo", @@ -4109,7 +4203,7 @@ "type": "object" }, "AppsDynamiteStorageBorderStyle": { - "description": "Represents the complete border style applied to widgets.", + "description": "The style options for the border of a card or widget, including the border type and color.", "id": "AppsDynamiteStorageBorderStyle", "properties": { "cornerRadius": { @@ -4292,25 +4386,11 @@ "id": "AppsDynamiteStorageColumns", "properties": { "columnItems": { - "description": "Each card supports up to 2 columns.", + "description": "Each card supports up to 2 columns. If the user's screen width is less than or equal to 480 pixels, the second column wraps below the first column.", "items": { "$ref": "AppsDynamiteStorageColumnsColumn" }, "type": "array" - }, - "wrapStyle": { - "description": "Controls how the column resizes based on screen width.", - "enum": [ - "WRAP_STYLE_UNSPECIFIED", - "NOWRAP", - "WRAP" - ], - "enumDescriptions": [ - "Unspecified.", - "Column widgets don't wrap.", - "Column Widgets wrap." - ], - "type": "string" } }, "type": "object" @@ -5470,6 +5550,10 @@ "$ref": "AppsDynamiteStorageCard", "description": "Card AddOn attachment with the possibility for specifying editable widgets." }, + "componentSearchInfo": { + "$ref": "AppsDynamiteSharedMessageComponentSearchInfo", + "description": "Contains additional metadata that further enhance the annotation when it is returned as part of search response. For example, this can be used to define how the attachment matches the search. Information can be used to highlight in rendering search results. The following are the different attachment text fields that are covered by this field: 1. ContextualAddOn.Card.CardHeader.title 2. CardItem.CardItemHeader.title" + }, "deprecatedAddOnData": { "$ref": "ContextualAddOnMarkup", "description": "Deprecated version of Gmail AddOn attachment." @@ -5976,6 +6060,31 @@ }, "type": "array" }, + "availableAnnotationToolTypes": { + "description": "Available screen annotation tool types.", + "items": { + "enum": [ + "ANNOTATION_TOOL_TYPE_UNSPECIFIED", + "ANNOTATION_TOOL_CLEAR_ALL", + "ANNOTATION_TOOL_LINE", + "ANNOTATION_TOOL_MAGIC_ERASER", + "ANNOTATION_TOOL_PEN", + "ANNOTATION_TOOL_SHAPE", + "ANNOTATION_TOOL_TEXT_BOX" + ], + "enumDescriptions": [ + "Annotation tool type unspecified.", + "Clears all annotations.", + "Draws vector lines.", + "Deletes elements that are touched.", + "Draws freeform strokes.", + "Draws simple vector shapes (such as rectangles or ellipses).", + "Allows adding/editing text at this location." + ], + "type": "string" + }, + "type": "array" + }, "availableReactions": { "description": "Output only. The set of reactions that clients are allowed to send and can expect to receive. Note that a device in the conference should have the MAY_SEND_REACTIONS privilege to be able to send reactions.", "items": { @@ -6105,6 +6214,10 @@ "description": "Indicates whether the chat lock is currently on or off.", "type": "boolean" }, + "coActivityLock": { + "description": "Indicates whether the co-activity lock is currently on or off.", + "type": "boolean" + }, "cseEnabled": { "description": "Whether Client-side Encryption is enabled for this conference.", "type": "boolean" @@ -6556,6 +6669,14 @@ "description": "The title of the activity in this co-activity session. For example, this might be the title of the video being co-watched, or the name of the round of a game being co-played.", "type": "string" }, + "addOnId": { + "description": "The add-on id of the current add-on being used for co-activity.", + "type": "string" + }, + "addOnStartingState": { + "$ref": "AddOnStartingState", + "description": "The starting state of the add-on frames for co-activity." + }, "coActivityApp": { "description": "Identifies the app handling this co-activity.", "enum": [ @@ -6583,6 +6704,19 @@ "." ], "type": "string" + }, + "initiatorDeviceId": { + "description": "The resource name of the device that initiated the co-activity.", + "type": "string" + }, + "presentationDeviceId": { + "description": "The resource name of the device that is presenting the add-on.", + "type": "string" + }, + "projectNumber": { + "description": "The project number of the add-on to determine version.", + "format": "int64", + "type": "string" } }, "type": "object" @@ -6958,9 +7092,13 @@ "description": "Annotation metadata for Data Loss Prevention that pertains to DLP violation on message send or edit events. It is used for client -\u003e BE communication and other downstream process in BE (e.g. storage and audit logging), and it should never be returned to the client.", "id": "DataLossPreventionMetadata", "properties": { + "dlpMessageScanRecord": { + "$ref": "DlpMessageScanRecord", + "description": "The scan record contains the action taken on the message send as well as scan the summary for the message contents and the attachment, if applicable." + }, "dlpScanSummary": { "$ref": "DlpScanSummary", - "description": "The DLP scan summary that should only be set after the message is scanned in the Chat backend." + "description": "Deprecated. To be replaced by DLP scan record. The DLP scan summary that should only be set after the message is scanned in the Chat backend." }, "warnAcknowledged": { "description": "Flag set by client on message resend to bypass WARN violation.", @@ -7295,6 +7433,89 @@ }, "type": "object" }, + "DlpMessageScanRecord": { + "description": "A summary of a DLP scan. This is a combination summary that contains both scan on message and scan on attachments if any.", + "id": "DlpMessageScanRecord", + "properties": { + "attachmentScanSummary": { + "$ref": "DlpScanSummary", + "description": "Summaries of the attachment scan if any." + }, + "dlpAction": { + "$ref": "DlpAction", + "description": "The applied action." + }, + "messageScanSummary": { + "$ref": "DlpScanSummary", + "description": "Summaries of the message scan." + }, + "scanOutcome": { + "description": "The DLP scan outcome for the message.", + "enum": [ + "SCAN_UNKNOWN_OUTCOME", + "SCAN_SUCCEEDED_NO_VIOLATION", + "SCAN_SUCCEEDED_BLOCK", + "SCAN_SUCCEEDED_WARN", + "SCAN_SUCCEEDED_AUDIT_ONLY", + "SCAN_FAILURE_EXCEPTION", + "SCAN_FAILURE_RULE_FETCH_FAILED", + "SCAN_FAILURE_TIMEOUT", + "SCAN_FAILURE_ALL_RULES_FAILED", + "SCAN_FAILURE_ILLEGAL_STATE_FOR_ATTACHMENTS", + "SCAN_SKIPPED_EXPERIMENT_DISABLED", + "SCAN_SKIPPED_CONSUMER", + "SCAN_SKIPPED_NON_HUMAN_USER", + "SCAN_SKIPPED_NO_MESSAGE", + "SCAN_SKIPPED_USER_ACKNOWLEDGED_WARNING", + "SCAN_SKIPPED_MESSAGE_FROM_UNSUPPORTED_ORIGIN", + "SCAN_SKIPPED_MESSAGE_SENT_DURING_SPACE_MIGRATION", + "SCAN_RULE_EVALUATION_SKIPPED_NO_RULES_FOUND", + "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES_FOR_ACTION_PARAMS", + "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES_FOR_TRIGGER", + "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES", + "SCAN_RULE_EVALUATION_SKIPPED_CHANGELING_PERMANENT_ERROR", + "SCAN_RULE_EVALUATION_SKIPPED_CHANGELING_EMPTY_RESPONSE", + "SCAN_RULE_EVALUATION_SKIPPED_UNSUPPORTED_FILE_TYPE", + "SCAN_SUCCEEDED_WITH_FAILURES_NO_VIOLATION", + "SCAN_SUCCEEDED_WITH_FAILURES_BLOCK", + "SCAN_SUCCEEDED_WITH_FAILURES_WARN", + "SCAN_SUCCEEDED_WITH_FAILURES_AUDIT_ONLY" + ], + "enumDescriptions": [ + "", + "This means no violation is detected on the given message/attachment.", + "Violation is detected. The message/attachment will be blocked (or deleted if this happens in failure recovery), the user will be warned, and the violation will be logged to BIP.", + "Violation is detected. The user will be warned, and the violation will be logged to BIP.", + "Violation is detected and will be logged to BIP (no user-facing action performed).", + "Rule fetch and evaluation were attempted but an exception occurred.", + "Rule fetch was attempted but failed, so rule evaluation could not be performed.", + "Rule fetch and evaluation were attempted but the scanning timed out.", + "Rule fetch completed and evaluation were attempted, but all of the rules failed to be evaluated.", + "An IllegalStateException is thrown when executing DLP on attachments. This could happen if the space row is missing.", + "Rule fetch and evaluation is skipped because DLP is not enabled for the user.", + "Rule fetch and evaluation are skipped because the user sending message is consumer.", + "Rule fetch and evaluation are skipped because the user sending message is a non-human user (i.e. a bot).", + "Rule fetch and evaluation are skipped because there is no message to scan. Deprecated: this should not happen since there must be message or attachment for DLP scan.", + "Rule fetch and evaluation are skipped because the user has acknowledged the warning on the message that triggered the Warn violation and sent the message anyway.", + "Scanning was skipped because the message originated from Interop or Babel.", + "Scanning was skipped because the message was sent while the space is in migration mode. See go/migration-mode for details.", + "Rule fetch happened, but rule evaluation is skipped because no rules were found.", + "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable to the given action params. Deprecated. Use SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES", + "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable to the given trigger. Deprecated. Use SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES", + "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable.", + "Rule fetch happened, but rule evaluation is skipped because Changeling returned permanent failure while converting the attachment to text.", + "Rule fetch happened, but rule evaluation is skipped because Changeling returned an empty response while converting the attachment to text.", + "Rule fetch happened, but rule evaluation is skipped because file type is unsupported.", + "Rules were fetched but some evaluations failed. No violation was found in the rules that were successfully evaluated.", + "Rules were fetched but some evaluations failed. A blocking violation was found in the rules that were successfully evaluated. The message/attachment will be blocked, the user will be notified, and the violation will be logged to BIP. A blocking violation takes precedence over all other violation types.", + "Rules were fetched but some evaluations failed. A warn violation was found in the rules that were successfully evaluated. The user will be warned, and the violation will be logged to BIP.", + "Rules were fetched but some evaluations failed. An audit-only violation was found in the rules that were successfully evaluated. The violation will be logged to BIP (no user-facing action performed)." + ], + "type": "string" + } + }, + "type": "object" + }, "DlpScanSummary": { "description": "A summary of a DLP scan event. This is a summary and should contain the minimum amount of data required to identify and process DLP scans. It is written to Starcast and encoded \u0026 returned to the client on attachment upload.", "id": "DlpScanSummary", @@ -7333,6 +7554,7 @@ "SCAN_RULE_EVALUATION_SKIPPED_NO_RULES_FOUND", "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES_FOR_ACTION_PARAMS", "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES_FOR_TRIGGER", + "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES", "SCAN_RULE_EVALUATION_SKIPPED_CHANGELING_PERMANENT_ERROR", "SCAN_RULE_EVALUATION_SKIPPED_CHANGELING_EMPTY_RESPONSE", "SCAN_RULE_EVALUATION_SKIPPED_UNSUPPORTED_FILE_TYPE", @@ -7360,8 +7582,9 @@ "Scanning was skipped because the message originated from Interop or Babel.", "Scanning was skipped because the message was sent while the space is in migration mode. See go/migration-mode for details.", "Rule fetch happened, but rule evaluation is skipped because no rules were found.", - "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable to the given action params.", - "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable to the given trigger.", + "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable to the given action params. Deprecated. Use SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES", + "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable to the given trigger. Deprecated. Use SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES", + "Rule fetch happened, but rule evaluation is skipped because none of the rules are applicable.", "Rule fetch happened, but rule evaluation is skipped because Changeling returned permanent failure while converting the attachment to text.", "Rule fetch happened, but rule evaluation is skipped because Changeling returned an empty response while converting the attachment to text.", "Rule fetch happened, but rule evaluation is skipped because file type is unsupported.", @@ -7371,6 +7594,20 @@ "Rules were fetched but some evaluations failed. An audit-only violation was found in the rules that were successfully evaluated. The violation will be logged to BIP (no user-facing action performed)." ], "type": "string" + }, + "scanTrigger": { + "description": "The event that triggered the scan. This corresponds to the rule trigger configured in admin console and maps to the different things that can be scanned.", + "enum": [ + "UNKNOWN_TRIGGER_TYPE", + "MESSAGE_SENT", + "ATTACHMENT_UPLOADED" + ], + "enumDescriptions": [ + "LINT.IfChange", + "", + "LINT.ThenChange(//depot/google3/java/com/google/apps/dynamite/v1/external/dlp/DlpTriggerInfo.java)" + ], + "type": "string" } }, "type": "object" @@ -9681,7 +9918,7 @@ "id": "GoogleChatV1ContextualAddOnMarkupCardSection", "properties": { "header": { - "description": "The header of the section, text formatted supported.", + "description": "The header of the section. Formatted text is supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.", "type": "string" }, "widgets": { @@ -9699,7 +9936,7 @@ "id": "GoogleChatV1WidgetMarkup", "properties": { "buttons": { - "description": "A list of buttons. Buttons is also oneof data and only one of these fields should be set.", + "description": "A list of buttons. Buttons is also `oneof data` and only one of these fields should be set.", "items": { "$ref": "GoogleChatV1WidgetMarkupButton" }, @@ -9882,7 +10119,7 @@ "id": "GoogleChatV1WidgetMarkupKeyValue", "properties": { "bottomLabel": { - "description": "The text of the bottom label. Formatted text supported.", + "description": "The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.", "type": "string" }, "button": { @@ -9890,7 +10127,7 @@ "description": "A button that can be clicked to trigger an action." }, "content": { - "description": "The text of the content. Formatted text supported and always required.", + "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 and Formatting text in Google Workspace Add-ons.", "type": "string" }, "contentMultiline": { @@ -9976,7 +10213,7 @@ "description": "The onclick action. Only the top label, bottom label and content region are clickable." }, "topLabel": { - "description": "The text of the top label. Formatted text supported.", + "description": "The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.", "type": "string" } }, @@ -10024,7 +10261,7 @@ "type": "object" }, "GoogleChatV1WidgetMarkupTextParagraph": { - "description": "A paragraph of text. Formatted text supported.", + "description": "A paragraph of text. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.", "id": "GoogleChatV1WidgetMarkupTextParagraph", "properties": { "text": { @@ -10994,6 +11231,7 @@ "YANDEX_BROWSER", "SILK_BROWSER", "COC_COC_BROWSER", + "HEADLESS_CHROME", "MAX_BROWSER_APP_VALUE", "GMAIL_APP", "GMAIL_INBOX_APP", @@ -11092,6 +11330,7 @@ "from customized OEM flavours). Yandex Browser", "Amazon Silk browser", "Popoular browser in Vietnam", + "Headless version of Chrome", "Tag for the maximum enum value that represents a browser. Enum values (strictly) between OTHER_APP and this value represent browsers. This should never appear in real data.", "Email apps Gmail", "Inbox by Gmail", @@ -12729,7 +12968,7 @@ "type": "object" }, "MembershipChangedMetadata": { - "description": "Annotation metadata to display system messages for membership changes. Next Tag: 8", + "description": "Annotation metadata to display system messages for membership changes. Next Tag: 13", "id": "MembershipChangedMetadata", "properties": { "affectedMemberProfiles": { @@ -12785,7 +13024,9 @@ "BOT_REMOVED", "KICKED_DUE_TO_OTR_CONFLICT", "ROLE_UPDATED", - "ROLE_TARGET_AUDIENCE_UPDATED" + "ROLE_TARGET_AUDIENCE_UPDATED", + "SPACE_LIMIT_EXCEEDED", + "HUMAN_MEMBERSHIP_DISPLAY_DISABLED" ], "enumDescriptions": [ "Default value for the enum. DO NOT USE.", @@ -12798,7 +13039,9 @@ "Bot removed from the room.", "This signifies the user is kicked because the user's OTR policy is conflicted with the room history settings. Joined -\u003e Non-member. One user.", "MembershipRole changed. Multiple users.", - "The room is now joinable by an" + "The room is now joinable by an", + "Space limit exceeded", + "HUMAN_MEMBERSHIP_DISPLAY_DISABLED indicates that the space has crossed the member size threshold above which human membership change system messages will be muted. This event can only occur once for a space over its lifetime. When this event is received, clients should display a system message stating that human membership changes will no longer be displayed in the space." ], "type": "string" } @@ -13011,6 +13254,14 @@ ], "type": "string" }, + "messageReference": { + "$ref": "MessageReference", + "description": "Contains reference to another message. It is used in shortcuts which are used to collect messages from different spaces with a certain common property into another space. For example, all @mentions of a user are collected into a mention shortcut space (go/chat-shortcuts-backend-design for more details). Most information from the source message (like text) are copied onto top-level Message fields of shortcut messages by the server. The MessageReference is helpful for clients to enable things like click navigation to source message." + }, + "messageSearchInfo": { + "$ref": "AppsDynamiteSharedMessageSearchInfo", + "description": "Contains additional metadata that further annotates this message when returned as a search response. For example, this field can be used to highlight messages during search results rendering. In this case, clients can use this field to highlight matched segments in the message text_body (defined with tag 6)." + }, "messageState": { "description": "State of the message, indicating whether the message is visible to all members in the group or is only visible to the sender only, or the private_message_viewer if it is set.", "enum": [ @@ -13023,6 +13274,11 @@ ], "type": "string" }, + "numberOfUnicodeEmojis": { + "description": "Indicates the number of unicode emojis in the message.", + "format": "int32", + "type": "integer" + }, "originAppSuggestions": { "description": "Indicates if this message contains any suggestions that were provided by any Apps.", "items": { @@ -13279,6 +13535,16 @@ }, "type": "object" }, + "MessageReference": { + "description": "Contains reference to another message. It is used in shortcuts which are used to collect messages from different spaces with a certain common property into another space. For example, all @mentions of a user are collected into a mention shortcut space (go/chat-shortcuts-backend-design for more details). Clients can use this reference to enable navigation to the source message when the shortcut message is clicked and also to identify a few other details about the source message. Other fields (like text) from the source message are copied on to the top-level fields in the Message proto by the server (More details in go/chat-shortcuts-client-server-design).", + "id": "MessageReference", + "properties": { + "sourceInfo": { + "$ref": "SourceMessageInfo" + } + }, + "type": "object" + }, "MessageSet": { "description": "This is proto2's version of MessageSet.", "id": "MessageSet", @@ -14064,6 +14330,10 @@ "description": "Presenter contains information about which device is currently presenting as well as which device requested the presenter to be set.", "id": "Presenter", "properties": { + "annotationInfo": { + "$ref": "AnnotationInfo", + "description": "Screen annotation information associated with this presentation session." + }, "byDeviceId": { "description": "The device resource name of the device which requested the current presenter to be set. This field can not be modified by clients.", "type": "string" @@ -15181,13 +15451,15 @@ "REQUIRED_FEATURE_MESSAGE_QUOTING", "REQUIRED_FEATURE_TOMBSTONES_IN_DMS_AND_UFRS", "REQUIRED_FEATURE_CUSTOM_HYPERLINK", - "REQUIRED_FEATURE_SMART_CHIP" + "REQUIRED_FEATURE_DRIVE_SMART_CHIP", + "REQUIRED_FEATURE_LEGACY_TOPIC_START" ], "enumDescriptions": [ "", "", "", "", + "", "" ], "type": "string" @@ -15684,6 +15956,26 @@ }, "type": "object" }, + "SearchLinkData": { + "description": "SearchLink metadata, for SEARCH_LINK segments. For a search link, the \"text\" field should contain the display text. This is currently not indexed.", + "id": "SearchLinkData", + "properties": { + "kgEntityConfidence": { + "description": "For lightweight scoring in serving time.", + "format": "float", + "type": "number" + }, + "mid": { + "description": "MID of the KG entity being linked.", + "type": "string" + }, + "queryBroadnessScore": { + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "SearchQualityMetadata": { "description": "Additional search quality metadata of the item.", "id": "SearchQualityMetadata", @@ -15890,6 +16182,10 @@ "$ref": "LinkData", "description": "Type-specific metadata. At most one of these should be populated, and the one that is populated should correspond to the type of the Segment. For LINK type:" }, + "searchLinkData": { + "$ref": "SearchLinkData", + "description": "For SEARCH_LINK type:" + }, "text": { "description": "Text content of the Segment. As a general rule, this field should contain the actual text that should be rendered in the UI. Thus, for a hashtag, it should be \"#Foo\", and for a link, it should be the display text. Clients that do not understand a particular segment type may use this text, along with the Formatting info below, as a fallback for display. The field is not required -- if all relevant information is carried in other metadata fields and there is no need for a fallback, or it is not practical for a fallback to be provided for any other reason, the field may be left blank. A standard example would be a user reference being transmitted between server layers, where a gaia-ID representation may be sufficient and there is no need for a textual fallback. In such a case, it would be valid and useful - though not required - for servers to compute and populate a fallback on the serving path.", "type": "string" @@ -15902,7 +16198,8 @@ "LINK", "USER_MENTION", "ALL_USER_MENTION", - "HASHTAG" + "HASHTAG", + "SEARCH_LINK" ], "enumDescriptions": [ "A TEXT segment represents plain-text subject to particular formatting constraints (as represented in the \"formatting\" field of the Segment).", @@ -15910,7 +16207,8 @@ "A LINK segment represents a link to a web entity. The \"text\" field should be used for anchor text. Additional link data should be put in the link_data protobuf.", "A USER_MENTION segment represents a reference to a (possibly non-Gaia, possibly off-network) user. The \"text\" field may be populated as a fallback, but information identifying the user should be contained in the user_mention_data protobuf. (The set of fields that are populated in user_mention_data may differ depending on the context in which the segment is viewed, but the interpretation of the fields is uniform. See comments over UserMentionData).", "An ALL_USER_MENTION segment represents a reference to all users in the context, that is, the conversation, discussion, or other context containing the segment. For example, an ALL_USER_MENTION segment (\"@all\") can be useful to ping all participants in a conversation if the notification setting of the conversation is not set to ping on normal messages. An ALL_USER_MENTION should be treated as a USER_MENTION for all users who receives the segment.", - "A HASHTAG segment represents a structured reference to a topic. The \"text\" field should represent display text (e.g. \"#Google\"), and additional metadata should be put in the Segment's hashtag_data field." + "A HASHTAG segment represents a structured reference to a topic. The \"text\" field should represent display text (e.g. \"#Google\"), and additional metadata should be put in the Segment's hashtag_data field.", + "A SEARCH_LINK segment respresents a link to search results for a KG entity. The \"text\" field should represent the part of the comment where the KG entity is extracted from, and additional metadata of the entity should be put in the Segment's search_link_data field." ], "type": "string" }, @@ -16156,6 +16454,10 @@ "description": "The chat lock of the meeting space that lets owner control whether the participants can send chat messages.", "type": "boolean" }, + "coActivityLock": { + "description": "The co-activity lock of the meeting space that lets owner control whether the participants can start/stop or update the state of co-activity.", + "type": "boolean" + }, "cohostArtifactSharingEnabled": { "description": "Whether meeting artifacts will be shared with cohosts.", "type": "boolean" @@ -16482,6 +16784,29 @@ }, "type": "object" }, + "SourceMessageInfo": { + "id": "SourceMessageInfo", + "properties": { + "messageId": { + "$ref": "MessageId", + "description": "Source message ID" + }, + "messageType": { + "enum": [ + "SOURCE_MESSAGE_TYPE_UNDEFINED", + "ROOT_MESSAGE", + "INLINE_REPLY" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "SourceResultCount": { "description": "Per source result count information.", "id": "SourceResultCount", @@ -18123,10 +18448,10 @@ ], "enumDescriptions": [ "Default value for the enum. DO NOT USE.", - "", - "", - "", - "", + "An @mention that invites a new member into the space", + "DEPRECATED: An @mention that removes a member from a space. Support for this has been removed.", + "An @mention of an existing member in the space.", + "An @mention of all members in the space.", "Server-generated user mention, for clients to strikethrough." ], "type": "string" diff --git a/cloudsearch/v1/cloudsearch-gen.go b/cloudsearch/v1/cloudsearch-gen.go index 50051605a7a..abb1e79bd5f 100644 --- a/cloudsearch/v1/cloudsearch-gen.go +++ b/cloudsearch/v1/cloudsearch-gen.go @@ -756,6 +756,72 @@ func (s *ActionParameter) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// AddOnFrameStartingState: Starting state for an individual add-on +// frame. +type AddOnFrameStartingState struct { + // AdditionalData: Additional data internal to the add-on that can be + // used to initialize itself. + AdditionalData string `json:"additionalData,omitempty"` + + // Uri: The uri of the artifact being used for an add-on co-activity. + Uri string `json:"uri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AdditionalData") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AdditionalData") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *AddOnFrameStartingState) MarshalJSON() ([]byte, error) { + type NoMethod AddOnFrameStartingState + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// AddOnStartingState: Starting state properties for add-on co-activity. +type AddOnStartingState struct { + // AddOnFrameStartingStates: List of starting state frames for the + // add-on co-activity. Keys for this map are the values of the + // AddOnFrameType enum. + AddOnFrameStartingStates map[string]AddOnFrameStartingState `json:"addOnFrameStartingStates,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AddOnFrameStartingStates") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AddOnFrameStartingStates") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *AddOnStartingState) MarshalJSON() ([]byte, error) { + type NoMethod AddOnStartingState + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + type AddonComposeUiActionMarkup struct { // Possible values: // "UNSPECIFIED" - Default. When unspecified, no action is taken. @@ -1079,6 +1145,40 @@ func (s *Annotation) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// AnnotationInfo: Information about the screen annotation session. +type AnnotationInfo struct { + // CoannotatorDeviceIds: The device resource names of other devices + // which can annotate the screen. + CoannotatorDeviceIds []string `json:"coannotatorDeviceIds,omitempty"` + + // IsActive: Whether the annotation is active. + IsActive bool `json:"isActive,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "CoannotatorDeviceIds") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CoannotatorDeviceIds") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *AnnotationInfo) MarshalJSON() ([]byte, error) { + type NoMethod AnnotationInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // AppId: Identifier of an App. type AppId struct { // AppType: Enum indicating the type of App this is. @@ -1108,6 +1208,7 @@ type AppId struct { // "ACTIVITY_FEED_APP" // "DRIVE_APP" // "CHAT_IN_MEET_APP" + // "SHORTCUT_APP" GsuiteAppType string `json:"gsuiteAppType,omitempty"` // Id: Numeric identifier of the App. Set to Project number for 1/3P @@ -1600,10 +1701,15 @@ type AppsDynamiteSharedBackendUploadMetadata struct { // // "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES_FOR_ACTION_PARAMS" // - Rule fetch happened, but rule evaluation is skipped because none of - // the rules are applicable to the given action params. + // the rules are applicable to the given action params. Deprecated. Use + // SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES // "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES_FOR_TRIGGER" - // Rule fetch happened, but rule evaluation is skipped because none of - // the rules are applicable to the given trigger. + // the rules are applicable to the given trigger. Deprecated. Use + // SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES + // "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES" - Rule fetch + // happened, but rule evaluation is skipped because none of the rules + // are applicable. // "SCAN_RULE_EVALUATION_SKIPPED_CHANGELING_PERMANENT_ERROR" - Rule // fetch happened, but rule evaluation is skipped because Changeling // returned permanent failure while converting the attachment to text. @@ -1636,11 +1742,19 @@ type AppsDynamiteSharedBackendUploadMetadata struct { // uploaded. DlpScanSummary *DlpScanSummary `json:"dlpScanSummary,omitempty"` + // Experiment: The list of experiments this video is enabled for Next + // tag: 19 + // + // Possible values: + // "UNKNOWN_EXPERIMENT" + // "KRONOS_FAST_FORMAT" + Experiment []string `json:"experiment,omitempty"` + // GroupId: GroupId to which this attachment is uploaded. GroupId *GroupId `json:"groupId,omitempty"` // IsClientSideTranscodedVideo: If the uploaded file is a video that has - // been transcoded on the client side Next tag: 18 + // been transcoded on the client side IsClientSideTranscodedVideo bool `json:"isClientSideTranscodedVideo,omitempty"` // OriginalDimension: Original dimension of the content. Only set for @@ -2130,15 +2244,14 @@ type AppsDynamiteSharedChatItemGroupInfo struct { // "IMMUTABLE_MEMBERSHIP_HUMAN_DM" - A DM with immutable group // membership. It can be a 1:1 DM or a group DM with multiple human // users. - // "POST_ROOM" - A post room. Topics in this room are organized in a - // post/reply style. See the design doc for more details: - // go/PostRoomsInDynamite. Deprecated. Post rooms are no longer - // supported. // "ACTIVITY_FEED" - Represents an Activity Feed space. These groups // are modeled like flat rooms and contain items for users to catch up // on important things. Each user should only have one group of this // type. See go/activity-feed. Deprecated: The go/activity-feed project // is cancelled and this should no longer be used. + // "SHORTCUT" - Represents a shortcut space. These groups are modeled + // like flat rooms and contain items for users to catch up on important + // things such as user mentioned messages and starred messages. // LINT.ThenChange(//depot/google3/logs/proto/apps_dynamite/dynamite_visu // al_element_entry.proto:LoggingGroupType,//depot/google3/java/com/googl // e/apps/dynamite/v1/web/ui/group/groups.js:LoggingGroupType) @@ -2665,6 +2778,15 @@ type AppsDynamiteSharedMeetMetadata struct { // regenerated, which will cause old meeting codes to become invalid. MeetingCode string `json:"meetingCode,omitempty"` + // MeetingType: Required. Type of the meeting. This controls the chat + // client UX. + // + // Possible values: + // "MEETING_TYPE_UNSPECIFIED" + // "HUDDLE" + // "CALL" + MeetingType string `json:"meetingType,omitempty"` + // MeetingUrl: Required. A URL, in the format // "https://meet.google.com/*" (e.g. // https://meet.google.com/cxv-zbgj-wzw), to identify and access the @@ -2814,6 +2936,41 @@ func (s *AppsDynamiteSharedMessageIntegrationPayload) MarshalJSON() ([]byte, err return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// AppsDynamiteSharedMessageSearchInfo: Metadata used to describe how to +// render a message in search results page, e.g., highlighting and +// snipetting. In future, we can use this proto to return more search +// specific data attached to a message. +type AppsDynamiteSharedMessageSearchInfo struct { + // MatchedSegmentsInTextBody: An example use case: clients can use this + // field to highlight matched segments in message text_body defined in + // http://google3/apps/dynamite/v1/frontend/api/message.proto;l=104;rcl=513400736. + MatchedSegmentsInTextBody []*AppsDynamiteSharedTextSegmentsWithDescription `json:"matchedSegmentsInTextBody,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "MatchedSegmentsInTextBody") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "MatchedSegmentsInTextBody") to include in API requests with the JSON + // null value. By default, fields with empty values are omitted from API + // requests. However, any field with an empty value appearing in + // NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *AppsDynamiteSharedMessageSearchInfo) MarshalJSON() ([]byte, error) { + type NoMethod AppsDynamiteSharedMessageSearchInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // AppsDynamiteSharedOrganizationInfo: Contains info about the entity // that something is, or is owned by. type AppsDynamiteSharedOrganizationInfo struct { @@ -3562,8 +3719,8 @@ func (s *AppsDynamiteStorageActionActionParameter) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// AppsDynamiteStorageBorderStyle: Represents the complete border style -// applied to widgets. +// AppsDynamiteStorageBorderStyle: The style options for the border of a +// card or widget, including the border type and color. type AppsDynamiteStorageBorderStyle struct { // CornerRadius: The corner radius for the border. CornerRadius int64 `json:"cornerRadius,omitempty"` @@ -3873,17 +4030,11 @@ func (s *AppsDynamiteStorageCardSection) MarshalJSON() ([]byte, error) { // AppsDynamiteStorageColumns: Represents a Columns widget that displays // a single row of columns. type AppsDynamiteStorageColumns struct { - // ColumnItems: Each card supports up to 2 columns. + // ColumnItems: Each card supports up to 2 columns. If the user's screen + // width is less than or equal to 480 pixels, the second column wraps + // below the first column. ColumnItems []*AppsDynamiteStorageColumnsColumn `json:"columnItems,omitempty"` - // WrapStyle: Controls how the column resizes based on screen width. - // - // Possible values: - // "WRAP_STYLE_UNSPECIFIED" - Unspecified. - // "NOWRAP" - Column widgets don't wrap. - // "WRAP" - Column Widgets wrap. - WrapStyle string `json:"wrapStyle,omitempty"` - // ForceSendFields is a list of field names (e.g. "ColumnItems") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -5636,6 +5787,16 @@ type Attachment struct { // specifying editable widgets. CardAddOnData *AppsDynamiteStorageCard `json:"cardAddOnData,omitempty"` + // ComponentSearchInfo: Contains additional metadata that further + // enhance the annotation when it is returned as part of search + // response. For example, this can be used to define how the attachment + // matches the search. Information can be used to highlight in rendering + // search results. The following are the different attachment text + // fields that are covered by this field: 1. + // ContextualAddOn.Card.CardHeader.title 2. + // CardItem.CardItemHeader.title + ComponentSearchInfo *AppsDynamiteSharedMessageComponentSearchInfo `json:"componentSearchInfo,omitempty"` + // DeprecatedAddOnData: Deprecated version of Gmail AddOn attachment. DeprecatedAddOnData *ContextualAddOnMarkup `json:"deprecatedAddOnData,omitempty"` @@ -6477,6 +6638,21 @@ type CallInfo struct { // disabled. AvailableAccessTypes []string `json:"availableAccessTypes,omitempty"` + // AvailableAnnotationToolTypes: Available screen annotation tool types. + // + // Possible values: + // "ANNOTATION_TOOL_TYPE_UNSPECIFIED" - Annotation tool type + // unspecified. + // "ANNOTATION_TOOL_CLEAR_ALL" - Clears all annotations. + // "ANNOTATION_TOOL_LINE" - Draws vector lines. + // "ANNOTATION_TOOL_MAGIC_ERASER" - Deletes elements that are touched. + // "ANNOTATION_TOOL_PEN" - Draws freeform strokes. + // "ANNOTATION_TOOL_SHAPE" - Draws simple vector shapes (such as + // rectangles or ellipses). + // "ANNOTATION_TOOL_TEXT_BOX" - Allows adding/editing text at this + // location. + AvailableAnnotationToolTypes []string `json:"availableAnnotationToolTypes,omitempty"` + // AvailableReactions: Output only. The set of reactions that clients // are allowed to send and can expect to receive. Note that a device in // the conference should have the MAY_SEND_REACTIONS privilege to be @@ -6638,6 +6814,10 @@ type CallSettings struct { // ChatLock: Indicates whether the chat lock is currently on or off. ChatLock bool `json:"chatLock,omitempty"` + // CoActivityLock: Indicates whether the co-activity lock is currently + // on or off. + CoActivityLock bool `json:"coActivityLock,omitempty"` + // CseEnabled: Whether Client-side Encryption is enabled for this // conference. CseEnabled bool `json:"cseEnabled,omitempty"` @@ -7399,6 +7579,14 @@ type CoActivity struct { // or the name of the round of a game being co-played. ActivityTitle string `json:"activityTitle,omitempty"` + // AddOnId: The add-on id of the current add-on being used for + // co-activity. + AddOnId string `json:"addOnId,omitempty"` + + // AddOnStartingState: The starting state of the add-on frames for + // co-activity. + AddOnStartingState *AddOnStartingState `json:"addOnStartingState,omitempty"` + // CoActivityApp: Identifies the app handling this co-activity. // // Possible values: @@ -7415,6 +7603,17 @@ type CoActivity struct { // "CO_ACTIVITY_APP_HAPPY_AARDVARK" - . CoActivityApp string `json:"coActivityApp,omitempty"` + // InitiatorDeviceId: The resource name of the device that initiated the + // co-activity. + InitiatorDeviceId string `json:"initiatorDeviceId,omitempty"` + + // PresentationDeviceId: The resource name of the device that is + // presenting the add-on. + PresentationDeviceId string `json:"presentationDeviceId,omitempty"` + + // ProjectNumber: The project number of the add-on to determine version. + ProjectNumber int64 `json:"projectNumber,omitempty,string"` + // ForceSendFields is a list of field names (e.g. "ActivityTitle") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -8276,23 +8475,30 @@ func (s *CustomerUserStats) MarshalJSON() ([]byte, error) { // downstream process in BE (e.g. storage and audit logging), and it // should never be returned to the client. type DataLossPreventionMetadata struct { - // DlpScanSummary: The DLP scan summary that should only be set after - // the message is scanned in the Chat backend. + // DlpMessageScanRecord: The scan record contains the action taken on + // the message send as well as scan the summary for the message contents + // and the attachment, if applicable. + DlpMessageScanRecord *DlpMessageScanRecord `json:"dlpMessageScanRecord,omitempty"` + + // DlpScanSummary: Deprecated. To be replaced by DLP scan record. The + // DLP scan summary that should only be set after the message is scanned + // in the Chat backend. DlpScanSummary *DlpScanSummary `json:"dlpScanSummary,omitempty"` // WarnAcknowledged: Flag set by client on message resend to bypass WARN // violation. WarnAcknowledged bool `json:"warnAcknowledged,omitempty"` - // ForceSendFields is a list of field names (e.g. "DlpScanSummary") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. + // ForceSendFields is a list of field names (e.g. + // "DlpMessageScanRecord") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DlpScanSummary") to + // NullFields is a list of field names (e.g. "DlpMessageScanRecord") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the @@ -8921,6 +9127,130 @@ func (s *DlpAction) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// DlpMessageScanRecord: A summary of a DLP scan. This is a combination +// summary that contains both scan on message and scan on attachments if +// any. +type DlpMessageScanRecord struct { + // AttachmentScanSummary: Summaries of the attachment scan if any. + AttachmentScanSummary *DlpScanSummary `json:"attachmentScanSummary,omitempty"` + + // DlpAction: The applied action. + DlpAction *DlpAction `json:"dlpAction,omitempty"` + + // MessageScanSummary: Summaries of the message scan. + MessageScanSummary *DlpScanSummary `json:"messageScanSummary,omitempty"` + + // ScanOutcome: The DLP scan outcome for the message. + // + // Possible values: + // "SCAN_UNKNOWN_OUTCOME" + // "SCAN_SUCCEEDED_NO_VIOLATION" - This means no violation is detected + // on the given message/attachment. + // "SCAN_SUCCEEDED_BLOCK" - Violation is detected. The + // message/attachment will be blocked (or deleted if this happens in + // failure recovery), the user will be warned, and the violation will be + // logged to BIP. + // "SCAN_SUCCEEDED_WARN" - Violation is detected. The user will be + // warned, and the violation will be logged to BIP. + // "SCAN_SUCCEEDED_AUDIT_ONLY" - Violation is detected and will be + // logged to BIP (no user-facing action performed). + // "SCAN_FAILURE_EXCEPTION" - Rule fetch and evaluation were attempted + // but an exception occurred. + // "SCAN_FAILURE_RULE_FETCH_FAILED" - Rule fetch was attempted but + // failed, so rule evaluation could not be performed. + // "SCAN_FAILURE_TIMEOUT" - Rule fetch and evaluation were attempted + // but the scanning timed out. + // "SCAN_FAILURE_ALL_RULES_FAILED" - Rule fetch completed and + // evaluation were attempted, but all of the rules failed to be + // evaluated. + // "SCAN_FAILURE_ILLEGAL_STATE_FOR_ATTACHMENTS" - An + // IllegalStateException is thrown when executing DLP on attachments. + // This could happen if the space row is missing. + // "SCAN_SKIPPED_EXPERIMENT_DISABLED" - Rule fetch and evaluation is + // skipped because DLP is not enabled for the user. + // "SCAN_SKIPPED_CONSUMER" - Rule fetch and evaluation are skipped + // because the user sending message is consumer. + // "SCAN_SKIPPED_NON_HUMAN_USER" - Rule fetch and evaluation are + // skipped because the user sending message is a non-human user (i.e. a + // bot). + // "SCAN_SKIPPED_NO_MESSAGE" - Rule fetch and evaluation are skipped + // because there is no message to scan. Deprecated: this should not + // happen since there must be message or attachment for DLP scan. + // "SCAN_SKIPPED_USER_ACKNOWLEDGED_WARNING" - Rule fetch and + // evaluation are skipped because the user has acknowledged the warning + // on the message that triggered the Warn violation and sent the message + // anyway. + // "SCAN_SKIPPED_MESSAGE_FROM_UNSUPPORTED_ORIGIN" - Scanning was + // skipped because the message originated from Interop or Babel. + // "SCAN_SKIPPED_MESSAGE_SENT_DURING_SPACE_MIGRATION" - Scanning was + // skipped because the message was sent while the space is in migration + // mode. See go/migration-mode for details. + // "SCAN_RULE_EVALUATION_SKIPPED_NO_RULES_FOUND" - Rule fetch + // happened, but rule evaluation is skipped because no rules were found. + // + // "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES_FOR_ACTION_PARAMS" + // - Rule fetch happened, but rule evaluation is skipped because none of + // the rules are applicable to the given action params. Deprecated. Use + // SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES + // "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES_FOR_TRIGGER" - + // Rule fetch happened, but rule evaluation is skipped because none of + // the rules are applicable to the given trigger. Deprecated. Use + // SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES + // "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES" - Rule fetch + // happened, but rule evaluation is skipped because none of the rules + // are applicable. + // "SCAN_RULE_EVALUATION_SKIPPED_CHANGELING_PERMANENT_ERROR" - Rule + // fetch happened, but rule evaluation is skipped because Changeling + // returned permanent failure while converting the attachment to text. + // "SCAN_RULE_EVALUATION_SKIPPED_CHANGELING_EMPTY_RESPONSE" - Rule + // fetch happened, but rule evaluation is skipped because Changeling + // returned an empty response while converting the attachment to text. + // "SCAN_RULE_EVALUATION_SKIPPED_UNSUPPORTED_FILE_TYPE" - Rule fetch + // happened, but rule evaluation is skipped because file type is + // unsupported. + // "SCAN_SUCCEEDED_WITH_FAILURES_NO_VIOLATION" - Rules were fetched + // but some evaluations failed. No violation was found in the rules that + // were successfully evaluated. + // "SCAN_SUCCEEDED_WITH_FAILURES_BLOCK" - Rules were fetched but some + // evaluations failed. A blocking violation was found in the rules that + // were successfully evaluated. The message/attachment will be blocked, + // the user will be notified, and the violation will be logged to BIP. A + // blocking violation takes precedence over all other violation types. + // "SCAN_SUCCEEDED_WITH_FAILURES_WARN" - Rules were fetched but some + // evaluations failed. A warn violation was found in the rules that were + // successfully evaluated. The user will be warned, and the violation + // will be logged to BIP. + // "SCAN_SUCCEEDED_WITH_FAILURES_AUDIT_ONLY" - Rules were fetched but + // some evaluations failed. An audit-only violation was found in the + // rules that were successfully evaluated. The violation will be logged + // to BIP (no user-facing action performed). + ScanOutcome string `json:"scanOutcome,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AttachmentScanSummary") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AttachmentScanSummary") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *DlpMessageScanRecord) MarshalJSON() ([]byte, error) { + type NoMethod DlpMessageScanRecord + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // DlpScanSummary: A summary of a DLP scan event. This is a summary and // should contain the minimum amount of data required to identify and // process DLP scans. It is written to Starcast and encoded & returned @@ -8995,10 +9325,15 @@ type DlpScanSummary struct { // // "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES_FOR_ACTION_PARAMS" // - Rule fetch happened, but rule evaluation is skipped because none of - // the rules are applicable to the given action params. + // the rules are applicable to the given action params. Deprecated. Use + // SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES // "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES_FOR_TRIGGER" - // Rule fetch happened, but rule evaluation is skipped because none of - // the rules are applicable to the given trigger. + // the rules are applicable to the given trigger. Deprecated. Use + // SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES + // "SCAN_RULE_EVALUATION_SKIPPED_NO_APPLICABLE_RULES" - Rule fetch + // happened, but rule evaluation is skipped because none of the rules + // are applicable. // "SCAN_RULE_EVALUATION_SKIPPED_CHANGELING_PERMANENT_ERROR" - Rule // fetch happened, but rule evaluation is skipped because Changeling // returned permanent failure while converting the attachment to text. @@ -9026,6 +9361,18 @@ type DlpScanSummary struct { // to BIP (no user-facing action performed). ScanOutcome string `json:"scanOutcome,omitempty"` + // ScanTrigger: The event that triggered the scan. This corresponds to + // the rule trigger configured in admin console and maps to the + // different things that can be scanned. + // + // Possible values: + // "UNKNOWN_TRIGGER_TYPE" - LINT.IfChange + // "MESSAGE_SENT" + // "ATTACHMENT_UPLOADED" - + // LINT.ThenChange(//depot/google3/java/com/google/apps/dynamite/v1/exter + // nal/dlp/DlpTriggerInfo.java) + ScanTrigger string `json:"scanTrigger,omitempty"` + // ForceSendFields is a list of field names (e.g. "DlpAction") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -12080,7 +12427,9 @@ func (s *GoogleChatV1ContextualAddOnMarkupCardCardHeader) MarshalJSON() ([]byte, // fixed width, so there is currently no need for layout properties // (e.g. float). type GoogleChatV1ContextualAddOnMarkupCardSection struct { - // Header: The header of the section, text formatted supported. + // Header: The header of the section. Formatted text is supported. For + // more information about formatting text, see Formatting text in Google + // Chat apps and Formatting text in Google Workspace Add-ons. Header string `json:"header,omitempty"` // Widgets: A section must contain at least 1 widget. @@ -12112,7 +12461,7 @@ func (s *GoogleChatV1ContextualAddOnMarkupCardSection) MarshalJSON() ([]byte, er // GoogleChatV1WidgetMarkup: A widget is a UI element that presents // texts, images, etc. type GoogleChatV1WidgetMarkup struct { - // Buttons: A list of buttons. Buttons is also oneof data and only one + // Buttons: A list of buttons. Buttons is also `oneof data` and only one // of these fields should be set. Buttons []*GoogleChatV1WidgetMarkupButton `json:"buttons,omitempty"` @@ -12385,13 +12734,17 @@ func (s *GoogleChatV1WidgetMarkupImageButton) MarshalJSON() ([]byte, error) { // such as onclick button. type GoogleChatV1WidgetMarkupKeyValue struct { // BottomLabel: The text of the bottom label. Formatted text supported. + // For more information about formatting text, see Formatting text in + // Google Chat apps and Formatting text in Google Workspace Add-ons. BottomLabel string `json:"bottomLabel,omitempty"` // Button: A button that can be clicked to trigger an action. Button *GoogleChatV1WidgetMarkupButton `json:"button,omitempty"` // Content: The text of the content. Formatted text supported and always - // required. + // required. For more information about formatting text, see Formatting + // text in Google Chat apps and Formatting text in Google Workspace + // Add-ons. Content string `json:"content,omitempty"` // ContentMultiline: If the content should be multiline. @@ -12441,7 +12794,9 @@ type GoogleChatV1WidgetMarkupKeyValue struct { // content region are clickable. OnClick *GoogleChatV1WidgetMarkupOnClick `json:"onClick,omitempty"` - // TopLabel: The text of the top label. Formatted text supported. + // TopLabel: The text of the top label. Formatted text supported. For + // more information about formatting text, see Formatting text in Google + // Chat apps and Formatting text in Google Workspace Add-ons. TopLabel string `json:"topLabel,omitempty"` // ForceSendFields is a list of field names (e.g. "BottomLabel") to @@ -12560,7 +12915,9 @@ func (s *GoogleChatV1WidgetMarkupTextButton) MarshalJSON() ([]byte, error) { } // GoogleChatV1WidgetMarkupTextParagraph: A paragraph of text. Formatted -// text supported. +// text supported. For more information about formatting text, see +// Formatting text in Google Chat apps and Formatting text in Google +// Workspace Add-ons. type GoogleChatV1WidgetMarkupTextParagraph struct { Text string `json:"text,omitempty"` @@ -13833,6 +14190,7 @@ type ImapSessionContext struct { // "YANDEX_BROWSER" - from customized OEM flavours). Yandex Browser // "SILK_BROWSER" - Amazon Silk browser // "COC_COC_BROWSER" - Popoular browser in Vietnam + // "HEADLESS_CHROME" - Headless version of Chrome // "MAX_BROWSER_APP_VALUE" - Tag for the maximum enum value that // represents a browser. Enum values (strictly) between OTHER_APP and // this value represent browsers. This should never appear in real data. @@ -16420,7 +16778,7 @@ func (s *MembershipChangeEvent) MarshalJSON() ([]byte, error) { } // MembershipChangedMetadata: Annotation metadata to display system -// messages for membership changes. Next Tag: 8 +// messages for membership changes. Next Tag: 13 type MembershipChangedMetadata struct { AffectedMemberProfiles []*Member `json:"affectedMemberProfiles,omitempty"` @@ -16460,6 +16818,14 @@ type MembershipChangedMetadata struct { // settings. Joined -> Non-member. One user. // "ROLE_UPDATED" - MembershipRole changed. Multiple users. // "ROLE_TARGET_AUDIENCE_UPDATED" - The room is now joinable by an + // "SPACE_LIMIT_EXCEEDED" - Space limit exceeded + // "HUMAN_MEMBERSHIP_DISPLAY_DISABLED" - + // HUMAN_MEMBERSHIP_DISPLAY_DISABLED indicates that the space has + // crossed the member size threshold above which human membership change + // system messages will be muted. This event can only occur once for a + // space over its lifetime. When this event is received, clients should + // display a system message stating that human membership changes will + // no longer be displayed in the space. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -16726,6 +17092,25 @@ type Message struct { // "ORIGIN_BACKFILL_FROM_GMAIL_ARCHIVE" MessageOrigin string `json:"messageOrigin,omitempty"` + // MessageReference: Contains reference to another message. It is used + // in shortcuts which are used to collect messages from different spaces + // with a certain common property into another space. For example, all + // @mentions of a user are collected into a mention shortcut space + // (go/chat-shortcuts-backend-design for more details). Most information + // from the source message (like text) are copied onto top-level Message + // fields of shortcut messages by the server. The MessageReference is + // helpful for clients to enable things like click navigation to source + // message. + MessageReference *MessageReference `json:"messageReference,omitempty"` + + // MessageSearchInfo: Contains additional metadata that further + // annotates this message when returned as a search response. For + // example, this field can be used to highlight messages during search + // results rendering. In this case, clients can use this field to + // highlight matched segments in the message text_body (defined with tag + // 6). + MessageSearchInfo *AppsDynamiteSharedMessageSearchInfo `json:"messageSearchInfo,omitempty"` + // MessageState: State of the message, indicating whether the message is // visible to all members in the group or is only visible to the sender // only, or the private_message_viewer if it is set. @@ -16736,6 +17121,10 @@ type Message struct { // and the private_message_viewer if set. MessageState string `json:"messageState,omitempty"` + // NumberOfUnicodeEmojis: Indicates the number of unicode emojis in the + // message. + NumberOfUnicodeEmojis int64 `json:"numberOfUnicodeEmojis,omitempty"` + // OriginAppSuggestions: Indicates if this message contains any // suggestions that were provided by any Apps. OriginAppSuggestions []*AppsDynamiteSharedOriginAppSuggestion `json:"originAppSuggestions,omitempty"` @@ -17113,6 +17502,42 @@ func (s *MessageProps) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// MessageReference: Contains reference to another message. It is used +// in shortcuts which are used to collect messages from different spaces +// with a certain common property into another space. For example, all +// @mentions of a user are collected into a mention shortcut space +// (go/chat-shortcuts-backend-design for more details). Clients can use +// this reference to enable navigation to the source message when the +// shortcut message is clicked and also to identify a few other details +// about the source message. Other fields (like text) from the source +// message are copied on to the top-level fields in the Message proto by +// the server (More details in go/chat-shortcuts-client-server-design). +type MessageReference struct { + SourceInfo *SourceMessageInfo `json:"sourceInfo,omitempty"` + + // ForceSendFields is a list of field names (e.g. "SourceInfo") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "SourceInfo") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *MessageReference) MarshalJSON() ([]byte, error) { + type NoMethod MessageReference + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // MessageSet: This is proto2's version of MessageSet. type MessageSet struct { } @@ -18456,6 +18881,10 @@ func (s *PrefWritten) MarshalJSON() ([]byte, error) { // currently presenting as well as which device requested the presenter // to be set. type Presenter struct { + // AnnotationInfo: Screen annotation information associated with this + // presentation session. + AnnotationInfo *AnnotationInfo `json:"annotationInfo,omitempty"` + // ByDeviceId: The device resource name of the device which requested // the current presenter to be set. This field can not be modified by // clients. @@ -18469,7 +18898,7 @@ type Presenter struct { // presenting device. PresenterDeviceId string `json:"presenterDeviceId,omitempty"` - // ForceSendFields is a list of field names (e.g. "ByDeviceId") to + // ForceSendFields is a list of field names (e.g. "AnnotationInfo") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -18477,12 +18906,13 @@ type Presenter struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ByDeviceId") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "AnnotationInfo") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. NullFields []string `json:"-"` } @@ -20128,7 +20558,8 @@ type RequiredMessageFeaturesMetadata struct { // "REQUIRED_FEATURE_MESSAGE_QUOTING" // "REQUIRED_FEATURE_TOMBSTONES_IN_DMS_AND_UFRS" // "REQUIRED_FEATURE_CUSTOM_HYPERLINK" - // "REQUIRED_FEATURE_SMART_CHIP" + // "REQUIRED_FEATURE_DRIVE_SMART_CHIP" + // "REQUIRED_FEATURE_LEGACY_TOPIC_START" RequiredFeatures []string `json:"requiredFeatures,omitempty"` // ForceSendFields is a list of field names (e.g. "RequiredFeatures") to @@ -21039,6 +21470,58 @@ func (s *SearchItemsByViewUrlResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// SearchLinkData: SearchLink metadata, for SEARCH_LINK segments. For a +// search link, the "text" field should contain the display text. This +// is currently not indexed. +type SearchLinkData struct { + // KgEntityConfidence: For lightweight scoring in serving time. + KgEntityConfidence float64 `json:"kgEntityConfidence,omitempty"` + + // Mid: MID of the KG entity being linked. + Mid string `json:"mid,omitempty"` + + QueryBroadnessScore float64 `json:"queryBroadnessScore,omitempty"` + + // ForceSendFields is a list of field names (e.g. "KgEntityConfidence") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "KgEntityConfidence") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *SearchLinkData) MarshalJSON() ([]byte, error) { + type NoMethod SearchLinkData + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *SearchLinkData) UnmarshalJSON(data []byte) error { + type NoMethod SearchLinkData + var s1 struct { + KgEntityConfidence gensupport.JSONFloat64 `json:"kgEntityConfidence"` + QueryBroadnessScore gensupport.JSONFloat64 `json:"queryBroadnessScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.KgEntityConfidence = float64(s1.KgEntityConfidence) + s.QueryBroadnessScore = float64(s1.QueryBroadnessScore) + return nil +} + // SearchQualityMetadata: Additional search quality metadata of the // item. type SearchQualityMetadata struct { @@ -21320,6 +21803,9 @@ type Segment struct { // type of the Segment. For LINK type: LinkData *LinkData `json:"linkData,omitempty"` + // SearchLinkData: For SEARCH_LINK type: + SearchLinkData *SearchLinkData `json:"searchLinkData,omitempty"` + // Text: Text content of the Segment. As a general rule, this field // should contain the actual text that should be rendered in the UI. // Thus, for a hashtag, it should be "#Foo", and for a link, it should @@ -21369,6 +21855,11 @@ type Segment struct { // a topic. The "text" field should represent display text (e.g. // "#Google"), and additional metadata should be put in the Segment's // hashtag_data field. + // "SEARCH_LINK" - A SEARCH_LINK segment respresents a link to search + // results for a KG entity. The "text" field should represent the part + // of the comment where the KG entity is extracted from, and additional + // metadata of the entity should be put in the Segment's + // search_link_data field. Type string `json:"type,omitempty"` // UserMentionData: For USER_MENTION type: @@ -21689,6 +22180,11 @@ type Settings struct { // whether the participants can send chat messages. ChatLock bool `json:"chatLock,omitempty"` + // CoActivityLock: The co-activity lock of the meeting space that lets + // owner control whether the participants can start/stop or update the + // state of co-activity. + CoActivityLock bool `json:"coActivityLock,omitempty"` + // CohostArtifactSharingEnabled: Whether meeting artifacts will be // shared with cohosts. CohostArtifactSharingEnabled bool `json:"cohostArtifactSharingEnabled,omitempty"` @@ -22289,6 +22785,39 @@ func (s *SourceCrowdingConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type SourceMessageInfo struct { + // MessageId: Source message ID + MessageId *MessageId `json:"messageId,omitempty"` + + // Possible values: + // "SOURCE_MESSAGE_TYPE_UNDEFINED" + // "ROOT_MESSAGE" + // "INLINE_REPLY" + MessageType string `json:"messageType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "MessageId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "MessageId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *SourceMessageInfo) MarshalJSON() ([]byte, error) { + type NoMethod SourceMessageInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // SourceResultCount: Per source result count information. type SourceResultCount struct { // HasMoreResults: Whether there are more search results for this @@ -25075,10 +25604,11 @@ type UserMentionMetadata struct { // Possible values: // "TYPE_UNSPECIFIED" - Default value for the enum. DO NOT USE. - // "INVITE" - // "UNINVITE" - // "MENTION" - // "MENTION_ALL" + // "INVITE" - An @mention that invites a new member into the space + // "UNINVITE" - DEPRECATED: An @mention that removes a member from a + // space. Support for this has been removed. + // "MENTION" - An @mention of an existing member in the space. + // "MENTION_ALL" - An @mention of all members in the space. // "FAILED_TO_ADD" - Server-generated user mention, for clients to // strikethrough. Type string `json:"type,omitempty"` diff --git a/cloudtrace/v2/cloudtrace-api.json b/cloudtrace/v2/cloudtrace-api.json index c0ec86391c1..bf9df73e5b2 100644 --- a/cloudtrace/v2/cloudtrace-api.json +++ b/cloudtrace/v2/cloudtrace-api.json @@ -181,7 +181,7 @@ } } }, - "revision": "20230126", + "revision": "20230511", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Annotation": { @@ -227,7 +227,7 @@ "additionalProperties": { "$ref": "AttributeValue" }, - "description": "A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: \"/instance_id\": { \"string_value\": { \"value\": \"my-instance\" } } \"/http/request_bytes\": { \"int_value\": 300 } \"abc.com/myattribute\": { \"bool_value\": false }", + "description": "A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: \"/instance_id\": { \"string_value\": { \"value\": \"my-instance\" } } \"/http/request_bytes\": { \"int_value\": 300 } \"example.com/myattribute\": { \"bool_value\": false }", "type": "object" }, "droppedAttributesCount": { diff --git a/cloudtrace/v2/cloudtrace-gen.go b/cloudtrace/v2/cloudtrace-gen.go index 548615a62cf..7431740e3e0 100644 --- a/cloudtrace/v2/cloudtrace-gen.go +++ b/cloudtrace/v2/cloudtrace-gen.go @@ -253,8 +253,8 @@ type Attributes struct { // 128 bytes long. The value can be a string up to 256 bytes, a signed // 64-bit integer, or the boolean values `true` or `false`. For example: // "/instance_id": { "string_value": { "value": "my-instance" } } - // "/http/request_bytes": { "int_value": 300 } "abc.com/myattribute": { - // "bool_value": false } + // "/http/request_bytes": { "int_value": 300 } + // "example.com/myattribute": { "bool_value": false } AttributeMap map[string]AttributeValue `json:"attributeMap,omitempty"` // DroppedAttributesCount: The number of attributes that were discarded. diff --git a/dlp/v2/dlp-api.json b/dlp/v2/dlp-api.json index 9e84a6c9e9f..feb31313568 100644 --- a/dlp/v2/dlp-api.json +++ b/dlp/v2/dlp-api.json @@ -3412,7 +3412,7 @@ } } }, - "revision": "20230428", + "revision": "20230514", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -4783,12 +4783,12 @@ "type": "object" }, "GooglePrivacyDlpV2DeidentifyDataSourceDetails": { - "description": "The results of a Deidentify action from an Inspect job.", + "description": "The results of a Deidentify action from an inspect job.", "id": "GooglePrivacyDlpV2DeidentifyDataSourceDetails", "properties": { "deidentifyStats": { "$ref": "GooglePrivacyDlpV2DeidentifyDataSourceStats", - "description": "Stats about de-identification." + "description": "Stats about the de-identification operation." }, "requestedOptions": { "$ref": "GooglePrivacyDlpV2RequestedDeidentifyOptions", @@ -7471,15 +7471,15 @@ "properties": { "snapshotDeidentifyTemplate": { "$ref": "GooglePrivacyDlpV2DeidentifyTemplate", - "description": "Snapshot of the state of the DeidentifyTemplate from the Deidentify action at the time this job was run." + "description": "Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run." }, "snapshotImageRedactTemplate": { "$ref": "GooglePrivacyDlpV2DeidentifyTemplate", - "description": "Snapshot of the state of the image redact DeidentifyTemplate from the Deidentify action at the time this job was run." + "description": "Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run." }, "snapshotStructuredDeidentifyTemplate": { "$ref": "GooglePrivacyDlpV2DeidentifyTemplate", - "description": "Snapshot of the state of the structured DeidentifyTemplate from the Deidentify action at the time this job was run." + "description": "Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run." } }, "type": "object" @@ -7612,11 +7612,11 @@ "type": "object" }, "GooglePrivacyDlpV2SensitivityScore": { - "description": "Score is a summary of all elements in the data profile. A higher number means more sensitive.", + "description": "Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive.", "id": "GooglePrivacyDlpV2SensitivityScore", "properties": { "score": { - "description": "The score applied to the resource.", + "description": "The sensitivity score applied to the resource.", "enum": [ "SENSITIVITY_SCORE_UNSPECIFIED", "SENSITIVITY_LOW", @@ -7625,9 +7625,9 @@ ], "enumDescriptions": [ "Unused.", - "No sensitive information detected. Limited access.", - "Medium risk - PII, potentially sensitive data, or fields with free-text data that are at higher risk of having intermittent sensitive data. Consider limiting access.", - "High risk – SPII may be present. Exfiltration of data may lead to user data loss. Re-identification of users may be possible. Consider limiting usage and or removing SPII." + "No sensitive information detected. The resource isn't publicly accessible.", + "Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.", + "High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII." ], "type": "string" } @@ -7896,7 +7896,7 @@ "type": "string" }, "datasetProjectId": { - "description": "The GCP project ID that owns the BigQuery dataset.", + "description": "The Google Cloud project ID that owns the BigQuery dataset.", "type": "string" }, "encryptionStatus": { diff --git a/dlp/v2/dlp-gen.go b/dlp/v2/dlp-gen.go index fcf98e687eb..4080edf59b5 100644 --- a/dlp/v2/dlp-gen.go +++ b/dlp/v2/dlp-gen.go @@ -2969,9 +2969,9 @@ func (s *GooglePrivacyDlpV2DeidentifyContentResponse) MarshalJSON() ([]byte, err } // GooglePrivacyDlpV2DeidentifyDataSourceDetails: The results of a -// Deidentify action from an Inspect job. +// Deidentify action from an inspect job. type GooglePrivacyDlpV2DeidentifyDataSourceDetails struct { - // DeidentifyStats: Stats about de-identification. + // DeidentifyStats: Stats about the de-identification operation. DeidentifyStats *GooglePrivacyDlpV2DeidentifyDataSourceStats `json:"deidentifyStats,omitempty"` // RequestedOptions: De-identification config used for the request. @@ -7746,18 +7746,18 @@ type GooglePrivacyDlpV2ReplaceWithInfoTypeConfig struct { // GooglePrivacyDlpV2RequestedDeidentifyOptions: De-id options. type GooglePrivacyDlpV2RequestedDeidentifyOptions struct { // SnapshotDeidentifyTemplate: Snapshot of the state of the - // DeidentifyTemplate from the Deidentify action at the time this job + // `DeidentifyTemplate` from the Deidentify action at the time this job // was run. SnapshotDeidentifyTemplate *GooglePrivacyDlpV2DeidentifyTemplate `json:"snapshotDeidentifyTemplate,omitempty"` // SnapshotImageRedactTemplate: Snapshot of the state of the image - // redact DeidentifyTemplate from the Deidentify action at the time this - // job was run. + // transformation `DeidentifyTemplate` from the `Deidentify` action at + // the time this job was run. SnapshotImageRedactTemplate *GooglePrivacyDlpV2DeidentifyTemplate `json:"snapshotImageRedactTemplate,omitempty"` // SnapshotStructuredDeidentifyTemplate: Snapshot of the state of the - // structured DeidentifyTemplate from the Deidentify action at the time - // this job was run. + // structured `DeidentifyTemplate` from the `Deidentify` action at the + // time this job was run. SnapshotStructuredDeidentifyTemplate *GooglePrivacyDlpV2DeidentifyTemplate `json:"snapshotStructuredDeidentifyTemplate,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -8049,21 +8049,24 @@ func (s *GooglePrivacyDlpV2SelectedInfoTypes) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GooglePrivacyDlpV2SensitivityScore: Score is a summary of all -// elements in the data profile. A higher number means more sensitive. +// GooglePrivacyDlpV2SensitivityScore: Score is calculated from of all +// elements in the data profile. A higher level means the data is more +// sensitive. type GooglePrivacyDlpV2SensitivityScore struct { - // Score: The score applied to the resource. + // Score: The sensitivity score applied to the resource. // // Possible values: // "SENSITIVITY_SCORE_UNSPECIFIED" - Unused. - // "SENSITIVITY_LOW" - No sensitive information detected. Limited - // access. - // "SENSITIVITY_MODERATE" - Medium risk - PII, potentially sensitive - // data, or fields with free-text data that are at higher risk of having - // intermittent sensitive data. Consider limiting access. - // "SENSITIVITY_HIGH" - High risk – SPII may be present. - // Exfiltration of data may lead to user data loss. Re-identification of - // users may be possible. Consider limiting usage and or removing SPII. + // "SENSITIVITY_LOW" - No sensitive information detected. The resource + // isn't publicly accessible. + // "SENSITIVITY_MODERATE" - Medium risk. Contains personally + // identifiable information (PII), potentially sensitive data, or fields + // with free-text data that are at a higher risk of having intermittent + // sensitive data. Consider limiting access. + // "SENSITIVITY_HIGH" - High risk. Sensitive personally identifiable + // information (SPII) can be present. Exfiltration of data can lead to + // user data loss. Re-identification of users might be possible. + // Consider limiting usage and or removing SPII. Score string `json:"score,omitempty"` // ForceSendFields is a list of field names (e.g. "Score") to @@ -8526,7 +8529,8 @@ type GooglePrivacyDlpV2TableDataProfile struct { // supported locations. DatasetLocation string `json:"datasetLocation,omitempty"` - // DatasetProjectId: The GCP project ID that owns the BigQuery dataset. + // DatasetProjectId: The Google Cloud project ID that owns the BigQuery + // dataset. DatasetProjectId string `json:"datasetProjectId,omitempty"` // EncryptionStatus: How the table is encrypted. diff --git a/drive/v3/drive-api.json b/drive/v3/drive-api.json index 56511da5f55..9e8ba82bdcd 100644 --- a/drive/v3/drive-api.json +++ b/drive/v3/drive-api.json @@ -29,35 +29,62 @@ } } }, - "basePath": "/drive/v3/", - "baseUrl": "https://www.googleapis.com/drive/v3/", + "basePath": "", + "baseUrl": "https://www.googleapis.com/", "batchPath": "batch/drive/v3", - "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", + "description": "The Google Drive API allows clients to access resources from Google Drive.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"VYc8DWo_6wRTElVugbtvWfkARsc/OgtZCpoen_8IW8oaECY1TAD8ttU\"", "icons": { - "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", - "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "drive:v3", "kind": "discovery#restDescription", + "mtlsRootUrl": "https://www.mtls.googleapis.com/", "name": "drive", "ownerDomain": "google.com", "ownerName": "Google", "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, "alt": { "default": "json", - "description": "Data format for the response.", + "description": "Data format for response.", "enum": [ - "json" + "json", + "media", + "proto" ], "enumDescriptions": [ - "Responses with Content-Type of application/json" + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string" }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", @@ -80,12 +107,17 @@ "type": "boolean" }, "quotaUser": { - "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, - "userIp": { - "description": "Deprecated. Please use quotaUser instead.", + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } @@ -96,9 +128,12 @@ "methods": { "get": { "description": "Gets information about the user, the user's Drive, and system capabilities.", + "flatPath": "drive/v3/about", "httpMethod": "GET", "id": "drive.about.get", - "path": "about", + "parameterOrder": [], + "parameters": {}, + "path": "drive/v3/about", "response": { "$ref": "About" }, @@ -118,11 +153,13 @@ "methods": { "getStartPageToken": { "description": "Gets the starting pageToken for listing future changes.", + "flatPath": "drive/v3/changes/startPageToken", "httpMethod": "GET", "id": "drive.changes.getStartPageToken", + "parameterOrder": [], "parameters": { "driveId": { - "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.", + "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.", "location": "query", "type": "string" }, @@ -134,17 +171,17 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } }, - "path": "changes/startPageToken", + "path": "drive/v3/changes/startPageToken", "response": { "$ref": "StartPageToken" }, @@ -160,6 +197,7 @@ }, "list": { "description": "Lists the changes for a user or shared drive.", + "flatPath": "drive/v3/changes", "httpMethod": "GET", "id": "drive.changes.list", "parameterOrder": [ @@ -167,7 +205,7 @@ ], "parameters": { "driveId": { - "description": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", + "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.", "location": "query", "type": "string" }, @@ -184,7 +222,7 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -201,7 +239,7 @@ }, "includeTeamDriveItems": { "default": "false", - "description": "Deprecated use includeItemsFromAllDrives instead.", + "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -240,17 +278,17 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } }, - "path": "changes", + "path": "drive/v3/changes", "response": { "$ref": "ChangeList" }, @@ -266,7 +304,8 @@ "supportsSubscription": true }, "watch": { - "description": "Subscribes to changes for a user. To use this method, you must include the pageToken query parameter.", + "description": "Subscribes to changes for a user.", + "flatPath": "drive/v3/changes/watch", "httpMethod": "POST", "id": "drive.changes.watch", "parameterOrder": [ @@ -274,7 +313,7 @@ ], "parameters": { "driveId": { - "description": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", + "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.", "location": "query", "type": "string" }, @@ -291,7 +330,7 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -308,7 +347,7 @@ }, "includeTeamDriveItems": { "default": "false", - "description": "Deprecated use includeItemsFromAllDrives instead.", + "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -347,17 +386,17 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } }, - "path": "changes/watch", + "path": "drive/v3/changes/watch", "request": { "$ref": "Channel", "parameterName": "resource" @@ -381,10 +420,13 @@ "channels": { "methods": { "stop": { - "description": "Stop watching resources through this channel", + "description": "Stop watching resources through this channel.", + "flatPath": "drive/v3/channels/stop", "httpMethod": "POST", "id": "drive.channels.stop", - "path": "channels/stop", + "parameterOrder": [], + "parameters": {}, + "path": "drive/v3/channels/stop", "request": { "$ref": "Channel", "parameterName": "resource" @@ -405,6 +447,7 @@ "methods": { "create": { "description": "Creates a comment on a file.", + "flatPath": "drive/v3/files/{fileId}/comments", "httpMethod": "POST", "id": "drive.comments.create", "parameterOrder": [ @@ -418,7 +461,7 @@ "type": "string" } }, - "path": "files/{fileId}/comments", + "path": "drive/v3/files/{fileId}/comments", "request": { "$ref": "Comment" }, @@ -432,6 +475,7 @@ }, "delete": { "description": "Deletes a comment.", + "flatPath": "drive/v3/files/{fileId}/comments/{commentId}", "httpMethod": "DELETE", "id": "drive.comments.delete", "parameterOrder": [ @@ -452,7 +496,7 @@ "type": "string" } }, - "path": "files/{fileId}/comments/{commentId}", + "path": "drive/v3/files/{fileId}/comments/{commentId}", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" @@ -460,6 +504,7 @@ }, "get": { "description": "Gets a comment by ID.", + "flatPath": "drive/v3/files/{fileId}/comments/{commentId}", "httpMethod": "GET", "id": "drive.comments.get", "parameterOrder": [ @@ -486,7 +531,7 @@ "type": "boolean" } }, - "path": "files/{fileId}/comments/{commentId}", + "path": "drive/v3/files/{fileId}/comments/{commentId}", "response": { "$ref": "Comment" }, @@ -498,6 +543,7 @@ }, "list": { "description": "Lists a file's comments.", + "flatPath": "drive/v3/files/{fileId}/comments", "httpMethod": "GET", "id": "drive.comments.list", "parameterOrder": [ @@ -536,7 +582,7 @@ "type": "string" } }, - "path": "files/{fileId}/comments", + "path": "drive/v3/files/{fileId}/comments", "response": { "$ref": "CommentList" }, @@ -548,6 +594,7 @@ }, "update": { "description": "Updates a comment with patch semantics.", + "flatPath": "drive/v3/files/{fileId}/comments/{commentId}", "httpMethod": "PATCH", "id": "drive.comments.update", "parameterOrder": [ @@ -568,7 +615,7 @@ "type": "string" } }, - "path": "files/{fileId}/comments/{commentId}", + "path": "drive/v3/files/{fileId}/comments/{commentId}", "request": { "$ref": "Comment" }, @@ -586,6 +633,7 @@ "methods": { "create": { "description": "Creates a shared drive.", + "flatPath": "drive/v3/drives", "httpMethod": "POST", "id": "drive.drives.create", "parameterOrder": [ @@ -599,7 +647,7 @@ "type": "string" } }, - "path": "drives", + "path": "drive/v3/drives", "request": { "$ref": "Drive" }, @@ -612,6 +660,7 @@ }, "delete": { "description": "Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.", + "flatPath": "drive/v3/drives/{driveId}", "httpMethod": "DELETE", "id": "drive.drives.delete", "parameterOrder": [ @@ -620,7 +669,7 @@ "parameters": { "allowItemDeletion": { "default": "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.", + "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`.", "location": "query", "type": "boolean" }, @@ -637,13 +686,14 @@ "type": "boolean" } }, - "path": "drives/{driveId}", + "path": "drive/v3/drives/{driveId}", "scopes": [ "https://www.googleapis.com/auth/drive" ] }, "get": { "description": "Gets a shared drive's metadata by ID.", + "flatPath": "drive/v3/drives/{driveId}", "httpMethod": "GET", "id": "drive.drives.get", "parameterOrder": [ @@ -663,7 +713,7 @@ "type": "boolean" } }, - "path": "drives/{driveId}", + "path": "drive/v3/drives/{driveId}", "response": { "$ref": "Drive" }, @@ -674,6 +724,7 @@ }, "hide": { "description": "Hides a shared drive from the default view.", + "flatPath": "drive/v3/drives/{driveId}/hide", "httpMethod": "POST", "id": "drive.drives.hide", "parameterOrder": [ @@ -687,7 +738,7 @@ "type": "string" } }, - "path": "drives/{driveId}/hide", + "path": "drive/v3/drives/{driveId}/hide", "response": { "$ref": "Drive" }, @@ -696,9 +747,11 @@ ] }, "list": { - "description": "Lists the user's shared drives.", + "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](/drive/api/guides/search-shareddrives) guide.", + "flatPath": "drive/v3/drives", "httpMethod": "GET", "id": "drive.drives.list", + "parameterOrder": [], "parameters": { "pageSize": { "default": "10", @@ -726,7 +779,7 @@ "type": "boolean" } }, - "path": "drives", + "path": "drive/v3/drives", "response": { "$ref": "DriveList" }, @@ -737,6 +790,7 @@ }, "unhide": { "description": "Restores a shared drive to the default view.", + "flatPath": "drive/v3/drives/{driveId}/unhide", "httpMethod": "POST", "id": "drive.drives.unhide", "parameterOrder": [ @@ -750,7 +804,7 @@ "type": "string" } }, - "path": "drives/{driveId}/unhide", + "path": "drive/v3/drives/{driveId}/unhide", "response": { "$ref": "Drive" }, @@ -759,7 +813,8 @@ ] }, "update": { - "description": "Updates the metadata for a shared drive.", + "description": "Updates the metadate for a shared drive.", + "flatPath": "drive/v3/drives/{driveId}", "httpMethod": "PATCH", "id": "drive.drives.update", "parameterOrder": [ @@ -774,12 +829,12 @@ }, "useDomainAdminAccess": { "default": "false", - "description": "Issue the request as a domain administrator. If set to true, then the requester is granted access if they're an administrator of the domain to which the shared drive belongs.", + "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.", "location": "query", "type": "boolean" } }, - "path": "drives/{driveId}", + "path": "drive/v3/drives/{driveId}", "request": { "$ref": "Drive" }, @@ -795,7 +850,8 @@ "files": { "methods": { "copy": { - "description": "Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.", + "description": "Creates a copy of a file and applies any requested updates with patch semantics.", + "flatPath": "drive/v3/files/{fileId}/copy", "httpMethod": "POST", "id": "drive.files.copy", "parameterOrder": [ @@ -821,7 +877,7 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -849,12 +905,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } }, - "path": "files/{fileId}/copy", + "path": "drive/v3/files/{fileId}/copy", "request": { "$ref": "File" }, @@ -869,14 +925,15 @@ ] }, "create": { - "description": "Creates a file.", + "description": " Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5120GB - *Accepted Media MIME types:*`*/*` Note: 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 further information on uploading files, refer to [Upload files](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` 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 `title` 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 title. In cases where the extension is missing, Google Drive attempts to determine the extension based on the file's MIME type.", + "flatPath": "drive/v3/files", "httpMethod": "POST", "id": "drive.files.create", "mediaUpload": { "accept": [ "*/*" ], - "maxSize": "5120GB", + "maxSize": "5497558138880", "protocols": { "resumable": { "multipart": true, @@ -888,6 +945,7 @@ } } }, + "parameterOrder": [], "parameters": { "enforceSingleParent": { "default": "false", @@ -902,7 +960,7 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -930,7 +988,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -941,7 +999,7 @@ "type": "boolean" } }, - "path": "files", + "path": "drive/v3/files", "request": { "$ref": "File" }, @@ -953,11 +1011,11 @@ "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], - "supportsMediaUpload": true, - "supportsSubscription": true + "supportsMediaUpload": true }, "delete": { "description": "Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.", + "flatPath": "drive/v3/files/{fileId}", "httpMethod": "DELETE", "id": "drive.files.delete", "parameterOrder": [ @@ -966,7 +1024,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", + "description": "Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", "location": "query", "type": "boolean" }, @@ -984,12 +1042,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } }, - "path": "files/{fileId}", + "path": "drive/v3/files/{fileId}", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", @@ -997,9 +1055,11 @@ ] }, "emptyTrash": { - "description": "Permanently deletes all trashed files of a user or shared drive.", + "description": "Permanently deletes all of the user's trashed files.", + "flatPath": "drive/v3/files/trash", "httpMethod": "DELETE", "id": "drive.files.emptyTrash", + "parameterOrder": [], "parameters": { "driveId": { "description": "If set, empties the trash of the provided shared drive.", @@ -1008,18 +1068,19 @@ }, "enforceSingleParent": { "default": "false", - "description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", + "description": "Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", "location": "query", "type": "boolean" } }, - "path": "files/trash", + "path": "drive/v3/files/trash", "scopes": [ "https://www.googleapis.com/auth/drive" ] }, "export": { "description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.", + "flatPath": "drive/v3/files/{fileId}/export", "httpMethod": "GET", "id": "drive.files.export", "parameterOrder": [ @@ -1040,18 +1101,21 @@ "type": "string" } }, - "path": "files/{fileId}/export", + "path": "drive/v3/files/{fileId}/export", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.readonly" ], - "supportsMediaDownload": true + "supportsMediaDownload": true, + "useMediaDownloadService": true }, "generateIds": { "description": "Generates a set of file IDs which can be provided in create or copy requests.", + "flatPath": "drive/v3/files/generateIds", "httpMethod": "GET", "id": "drive.files.generateIds", + "parameterOrder": [], "parameters": { "count": { "default": "10", @@ -1070,12 +1134,12 @@ }, "type": { "default": "files", - "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')", + "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')", "location": "query", "type": "string" } }, - "path": "files/generateIds", + "path": "drive/v3/files/generateIds", "response": { "$ref": "GeneratedIds" }, @@ -1086,7 +1150,8 @@ ] }, "get": { - "description": "Gets a file's metadata or content by ID.", + "description": " Gets a file's metadata or content by ID. 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`](/drive/api/reference/rest/v3/files/export) instead. For further information on downloading files, refer to [Download files](/drive/api/guides/manage-downloads).", + "flatPath": "drive/v3/files/{fileId}", "httpMethod": "GET", "id": "drive.files.get", "parameterOrder": [ @@ -1106,7 +1171,7 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -1123,12 +1188,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } }, - "path": "files/{fileId}", + "path": "drive/v3/files/{fileId}", "response": { "$ref": "File" }, @@ -1146,24 +1211,26 @@ "useMediaDownloadService": true }, "list": { - "description": "Lists or searches files.", + "description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files](/drive/api/guides/search-files) guide. *Note:* 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 filter trashed files from the results.", + "flatPath": "drive/v3/files", "httpMethod": "GET", "id": "drive.files.list", + "parameterOrder": [], "parameters": { "corpora": { - "description": "Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.", + "description": "Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency.", "location": "query", "type": "string" }, "corpus": { - "description": "The source of files to list. Deprecated: use 'corpora' instead.", + "description": "Deprecated: The source of files to list. Use 'corpora' instead.", "enum": [ "domain", "user" ], "enumDescriptions": [ "Files shared to the user's domain.", - "Files owned by or shared to the user. If a user has permissions on a Shared Drive, the files inside it won't be retrieved unless the user has created, opened, or shared the file." + "Files owned by or shared to the user." ], "location": "query", "type": "string" @@ -1180,7 +1247,7 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -1191,7 +1258,7 @@ }, "includeTeamDriveItems": { "default": "false", - "description": "Deprecated use includeItemsFromAllDrives instead.", + "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1233,17 +1300,17 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } }, - "path": "files", + "path": "drive/v3/files", "response": { "$ref": "FileList" }, @@ -1259,6 +1326,7 @@ }, "listLabels": { "description": "Lists the labels on a file.", + "flatPath": "drive/v3/files/{fileId}/listLabels", "httpMethod": "GET", "id": "drive.files.listLabels", "parameterOrder": [ @@ -1266,14 +1334,14 @@ ], "parameters": { "fileId": { - "description": "The ID of the file.", + "description": "The ID for the file or shared drive.", "location": "path", "required": true, "type": "string" }, "maxResults": { "default": "100", - "description": "The maximum number of labels to return per page. When not set, this defaults to 100.", + "description": "The maximum number of labels to return per page. When not set, defaults to 100.", "format": "int32", "location": "query", "maximum": "100", @@ -1286,7 +1354,7 @@ "type": "string" } }, - "path": "files/{fileId}/listLabels", + "path": "drive/v3/files/{fileId}/listLabels", "response": { "$ref": "LabelList" }, @@ -1299,7 +1367,8 @@ ] }, "modifyLabels": { - "description": "Modifies the set of labels on a file.", + "description": "Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.", + "flatPath": "drive/v3/files/{fileId}/modifyLabels", "httpMethod": "POST", "id": "drive.files.modifyLabels", "parameterOrder": [ @@ -1307,13 +1376,13 @@ ], "parameters": { "fileId": { - "description": "The ID of the file for which the labels are modified.", + "description": "The ID of the file to which the labels belong.", "location": "path", "required": true, "type": "string" } }, - "path": "files/{fileId}/modifyLabels", + "path": "drive/v3/files/{fileId}/modifyLabels", "request": { "$ref": "ModifyLabelsRequest" }, @@ -1327,14 +1396,15 @@ ] }, "update": { - "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.", + "description": " Updates a file's metadata and/or content. 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:* 5120GB - *Accepted Media MIME types:*`*/*` Note: 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 further information on uploading files, refer to [Upload files](/drive/api/guides/manage-uploads).", + "flatPath": "drive/v3/files/{fileId}", "httpMethod": "PATCH", "id": "drive.files.update", "mediaUpload": { "accept": [ "*/*" ], - "maxSize": "5120GB", + "maxSize": "5497558138880", "protocols": { "resumable": { "multipart": true, @@ -1357,7 +1427,7 @@ }, "enforceSingleParent": { "default": "false", - "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + "description": "Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "type": "boolean" }, @@ -1368,7 +1438,7 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -1401,7 +1471,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1412,7 +1482,7 @@ "type": "boolean" } }, - "path": "files/{fileId}", + "path": "drive/v3/files/{fileId}", "request": { "$ref": "File" }, @@ -1429,7 +1499,8 @@ "supportsMediaUpload": true }, "watch": { - "description": "Subscribe to changes on a file.", + "description": "Subscribes to changes to a file.", + "flatPath": "drive/v3/files/{fileId}/watch", "httpMethod": "POST", "id": "drive.files.watch", "parameterOrder": [ @@ -1449,7 +1520,7 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -1466,12 +1537,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } }, - "path": "files/{fileId}/watch", + "path": "drive/v3/files/{fileId}/watch", "request": { "$ref": "Channel", "parameterName": "resource" @@ -1488,16 +1559,15 @@ "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], - "supportsMediaDownload": true, - "supportsSubscription": true, - "useMediaDownloadService": true + "supportsSubscription": true } } }, "permissions": { "methods": { "create": { - "description": "Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders \u0026 drives.", + "description": "Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + "flatPath": "drive/v3/files/{fileId}/permissions", "httpMethod": "POST", "id": "drive.permissions.create", "parameterOrder": [ @@ -1511,7 +1581,7 @@ }, "enforceSingleParent": { "default": "false", - "description": "Deprecated. See moveToNewOwnersRoot for details.", + "description": "Deprecated: See `moveToNewOwnersRoot` for details.", "location": "query", "type": "boolean" }, @@ -1523,7 +1593,7 @@ }, "moveToNewOwnersRoot": { "default": "false", - "description": "This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents are not changed.", + "description": "This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not changed.", "location": "query", "type": "boolean" }, @@ -1540,13 +1610,13 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "transferOwnership": { "default": "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. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.", + "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.", "location": "query", "type": "boolean" }, @@ -1557,7 +1627,7 @@ "type": "boolean" } }, - "path": "files/{fileId}/permissions", + "path": "drive/v3/files/{fileId}/permissions", "request": { "$ref": "Permission" }, @@ -1570,7 +1640,8 @@ ] }, "delete": { - "description": "Deletes a permission.", + "description": "Deletes a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + "flatPath": "drive/v3/files/{fileId}/permissions/{permissionId}", "httpMethod": "DELETE", "id": "drive.permissions.delete", "parameterOrder": [ @@ -1598,7 +1669,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1609,7 +1680,7 @@ "type": "boolean" } }, - "path": "files/{fileId}/permissions/{permissionId}", + "path": "drive/v3/files/{fileId}/permissions/{permissionId}", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" @@ -1617,6 +1688,7 @@ }, "get": { "description": "Gets a permission by ID.", + "flatPath": "drive/v3/files/{fileId}/permissions/{permissionId}", "httpMethod": "GET", "id": "drive.permissions.get", "parameterOrder": [ @@ -1644,7 +1716,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1655,7 +1727,7 @@ "type": "boolean" } }, - "path": "files/{fileId}/permissions/{permissionId}", + "path": "drive/v3/files/{fileId}/permissions/{permissionId}", "response": { "$ref": "Permission" }, @@ -1670,6 +1742,7 @@ }, "list": { "description": "Lists a file's or shared drive's permissions.", + "flatPath": "drive/v3/files/{fileId}/permissions", "httpMethod": "GET", "id": "drive.permissions.list", "parameterOrder": [ @@ -1708,7 +1781,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1719,7 +1792,7 @@ "type": "boolean" } }, - "path": "files/{fileId}/permissions", + "path": "drive/v3/files/{fileId}/permissions", "response": { "$ref": "PermissionList" }, @@ -1733,7 +1806,8 @@ ] }, "update": { - "description": "Updates a permission with patch semantics.", + "description": "Updates a permission with patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + "flatPath": "drive/v3/files/{fileId}/permissions/{permissionId}", "httpMethod": "PATCH", "id": "drive.permissions.update", "parameterOrder": [ @@ -1767,13 +1841,13 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "transferOwnership": { "default": "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. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.", + "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.", "location": "query", "type": "boolean" }, @@ -1784,7 +1858,7 @@ "type": "boolean" } }, - "path": "files/{fileId}/permissions/{permissionId}", + "path": "drive/v3/files/{fileId}/permissions/{permissionId}", "request": { "$ref": "Permission" }, @@ -1802,6 +1876,7 @@ "methods": { "create": { "description": "Creates a reply to a comment.", + "flatPath": "drive/v3/files/{fileId}/comments/{commentId}/replies", "httpMethod": "POST", "id": "drive.replies.create", "parameterOrder": [ @@ -1822,7 +1897,7 @@ "type": "string" } }, - "path": "files/{fileId}/comments/{commentId}/replies", + "path": "drive/v3/files/{fileId}/comments/{commentId}/replies", "request": { "$ref": "Reply" }, @@ -1836,6 +1911,7 @@ }, "delete": { "description": "Deletes a reply.", + "flatPath": "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "DELETE", "id": "drive.replies.delete", "parameterOrder": [ @@ -1863,7 +1939,7 @@ "type": "string" } }, - "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", + "path": "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file" @@ -1871,6 +1947,7 @@ }, "get": { "description": "Gets a reply by ID.", + "flatPath": "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "GET", "id": "drive.replies.get", "parameterOrder": [ @@ -1904,7 +1981,7 @@ "type": "string" } }, - "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", + "path": "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}", "response": { "$ref": "Reply" }, @@ -1916,6 +1993,7 @@ }, "list": { "description": "Lists a comment's replies.", + "flatPath": "drive/v3/files/{fileId}/comments/{commentId}/replies", "httpMethod": "GET", "id": "drive.replies.list", "parameterOrder": [ @@ -1956,7 +2034,7 @@ "type": "string" } }, - "path": "files/{fileId}/comments/{commentId}/replies", + "path": "drive/v3/files/{fileId}/comments/{commentId}/replies", "response": { "$ref": "ReplyList" }, @@ -1968,6 +2046,7 @@ }, "update": { "description": "Updates a reply with patch semantics.", + "flatPath": "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "PATCH", "id": "drive.replies.update", "parameterOrder": [ @@ -1995,7 +2074,7 @@ "type": "string" } }, - "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", + "path": "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}", "request": { "$ref": "Reply" }, @@ -2013,6 +2092,7 @@ "methods": { "delete": { "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.", + "flatPath": "drive/v3/files/{fileId}/revisions/{revisionId}", "httpMethod": "DELETE", "id": "drive.revisions.delete", "parameterOrder": [ @@ -2033,7 +2113,7 @@ "type": "string" } }, - "path": "files/{fileId}/revisions/{revisionId}", + "path": "drive/v3/files/{fileId}/revisions/{revisionId}", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", @@ -2042,6 +2122,7 @@ }, "get": { "description": "Gets a revision's metadata or content by ID.", + "flatPath": "drive/v3/files/{fileId}/revisions/{revisionId}", "httpMethod": "GET", "id": "drive.revisions.get", "parameterOrder": [ @@ -2068,7 +2149,7 @@ "type": "string" } }, - "path": "files/{fileId}/revisions/{revisionId}", + "path": "drive/v3/files/{fileId}/revisions/{revisionId}", "response": { "$ref": "Revision" }, @@ -2086,6 +2167,7 @@ }, "list": { "description": "Lists a file's revisions.", + "flatPath": "drive/v3/files/{fileId}/revisions", "httpMethod": "GET", "id": "drive.revisions.list", "parameterOrder": [ @@ -2113,7 +2195,7 @@ "type": "string" } }, - "path": "files/{fileId}/revisions", + "path": "drive/v3/files/{fileId}/revisions", "response": { "$ref": "RevisionList" }, @@ -2129,6 +2211,7 @@ }, "update": { "description": "Updates a revision with patch semantics.", + "flatPath": "drive/v3/files/{fileId}/revisions/{revisionId}", "httpMethod": "PATCH", "id": "drive.revisions.update", "parameterOrder": [ @@ -2149,7 +2232,7 @@ "type": "string" } }, - "path": "files/{fileId}/revisions/{revisionId}", + "path": "drive/v3/files/{fileId}/revisions/{revisionId}", "request": { "$ref": "Revision" }, @@ -2167,7 +2250,8 @@ "teamdrives": { "methods": { "create": { - "description": "Deprecated use drives.create instead.", + "description": "Deprecated: Use `drives.create` instead.", + "flatPath": "drive/v3/teamdrives", "httpMethod": "POST", "id": "drive.teamdrives.create", "parameterOrder": [ @@ -2181,7 +2265,7 @@ "type": "string" } }, - "path": "teamdrives", + "path": "drive/v3/teamdrives", "request": { "$ref": "TeamDrive" }, @@ -2193,7 +2277,8 @@ ] }, "delete": { - "description": "Deprecated use drives.delete instead.", + "description": "Deprecated: Use `drives.delete` instead.", + "flatPath": "drive/v3/teamdrives/{teamDriveId}", "httpMethod": "DELETE", "id": "drive.teamdrives.delete", "parameterOrder": [ @@ -2207,13 +2292,14 @@ "type": "string" } }, - "path": "teamdrives/{teamDriveId}", + "path": "drive/v3/teamdrives/{teamDriveId}", "scopes": [ "https://www.googleapis.com/auth/drive" ] }, "get": { - "description": "Deprecated use drives.get instead.", + "description": "Deprecated: Use `drives.get` instead.", + "flatPath": "drive/v3/teamdrives/{teamDriveId}", "httpMethod": "GET", "id": "drive.teamdrives.get", "parameterOrder": [ @@ -2233,7 +2319,7 @@ "type": "boolean" } }, - "path": "teamdrives/{teamDriveId}", + "path": "drive/v3/teamdrives/{teamDriveId}", "response": { "$ref": "TeamDrive" }, @@ -2243,9 +2329,11 @@ ] }, "list": { - "description": "Deprecated use drives.list instead.", + "description": "Deprecated: Use `drives.list` instead.", + "flatPath": "drive/v3/teamdrives", "httpMethod": "GET", "id": "drive.teamdrives.list", + "parameterOrder": [], "parameters": { "pageSize": { "default": "10", @@ -2273,7 +2361,7 @@ "type": "boolean" } }, - "path": "teamdrives", + "path": "drive/v3/teamdrives", "response": { "$ref": "TeamDriveList" }, @@ -2283,7 +2371,8 @@ ] }, "update": { - "description": "Deprecated use drives.update instead", + "description": "Deprecated: Use `drives.update` instead.", + "flatPath": "drive/v3/teamdrives/{teamDriveId}", "httpMethod": "PATCH", "id": "drive.teamdrives.update", "parameterOrder": [ @@ -2303,7 +2392,7 @@ "type": "boolean" } }, - "path": "teamdrives/{teamDriveId}", + "path": "drive/v3/teamdrives/{teamDriveId}", "request": { "$ref": "TeamDrive" }, @@ -2317,7 +2406,7 @@ } } }, - "revision": "20230423", + "revision": "20230502", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -2333,7 +2422,7 @@ "type": "boolean" }, "canCreateTeamDrives": { - "description": "Deprecated - use canCreateDrives instead.", + "description": "Deprecated: Use `canCreateDrives` instead.", "type": "boolean" }, "driveThemes": { @@ -2386,7 +2475,7 @@ }, "kind": { "default": "drive#about", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#about\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#about\"`.", "type": "string" }, "maxImportSizes": { @@ -2429,19 +2518,19 @@ "type": "object" }, "teamDriveThemes": { - "description": "Deprecated - use driveThemes instead.", + "description": "Deprecated: Use `driveThemes` instead.", "items": { "properties": { "backgroundImageLink": { - "description": "Deprecated - use driveThemes/backgroundImageLink instead.", + "description": "Deprecated: Use `driveThemes/backgroundImageLink` instead.", "type": "string" }, "colorRgb": { - "description": "Deprecated - use driveThemes/colorRgb instead.", + "description": "Deprecated: Use `driveThemes/colorRgb` instead.", "type": "string" }, "id": { - "description": "Deprecated - use driveThemes/id instead.", + "description": "Deprecated: Use `driveThemes/id` instead.", "type": "string" } }, @@ -2461,7 +2550,7 @@ "id": "Change", "properties": { "changeType": { - "description": "The type of the change. Possible values are file and drive.", + "description": "The type of the change. Possible values are `file` and `drive`.", "type": "string" }, "drive": { @@ -2482,7 +2571,7 @@ }, "kind": { "default": "drive#change", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#change\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#change\"`.", "type": "string" }, "removed": { @@ -2491,10 +2580,10 @@ }, "teamDrive": { "$ref": "TeamDrive", - "description": "Deprecated - use drive instead." + "description": "Deprecated: Use `drive` instead." }, "teamDriveId": { - "description": "Deprecated - use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "type": "string" }, "time": { @@ -2503,7 +2592,7 @@ "type": "string" }, "type": { - "description": "Deprecated - use changeType instead.", + "description": "Deprecated: Use `changeType` instead.", "type": "string" } }, @@ -2522,7 +2611,7 @@ }, "kind": { "default": "drive#changeList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#changeList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#changeList\"`.", "type": "string" }, "newStartPageToken": { @@ -2537,7 +2626,7 @@ "type": "object" }, "Channel": { - "description": "An notification channel used to watch for resource changes.", + "description": "A notification channel used to watch for resource changes.", "id": "Channel", "properties": { "address": { @@ -2555,12 +2644,11 @@ }, "kind": { "default": "api#channel", - "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".", + "description": "Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.", "type": "string" }, "params": { "additionalProperties": { - "description": "Declares a new parameter by name.", "type": "string" }, "description": "Additional parameters controlling delivery channel behavior. Optional.", @@ -2583,7 +2671,7 @@ "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.", + "description": "The type of delivery mechanism used for this channel.", "type": "string" } }, @@ -2594,12 +2682,12 @@ "id": "Comment", "properties": { "anchor": { - "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies.", + "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/drive/api/v3/manage-comments).", "type": "string" }, "author": { "$ref": "User", - "description": "The author of the comment. The author's email address and permission ID will not be populated." + "description": "Output only. The author of the comment. The author's email address and permission ID will not be populated." }, "content": { "annotations": { @@ -2608,7 +2696,7 @@ "drive.comments.update" ] }, - "description": "The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.", + "description": "The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.", "type": "string" }, "createdTime": { @@ -2617,20 +2705,20 @@ "type": "string" }, "deleted": { - "description": "Whether the comment has been deleted. A deleted comment has no content.", + "description": "Output only. Whether the comment has been deleted. A deleted comment has no content.", "type": "boolean" }, "htmlContent": { - "description": "The content of the comment with HTML formatting.", + "description": "Output only. The content of the comment with HTML formatting.", "type": "string" }, "id": { - "description": "The ID of the comment.", + "description": "Output only. The ID of the comment.", "type": "string" }, "kind": { "default": "drive#comment", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#comment\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#comment\"`.", "type": "string" }, "modifiedTime": { @@ -2653,14 +2741,14 @@ "type": "object" }, "replies": { - "description": "The full list of replies to the comment in chronological order.", + "description": "Output only. The full list of replies to the comment in chronological order.", "items": { "$ref": "Reply" }, "type": "array" }, "resolved": { - "description": "Whether the comment has been resolved by one of its replies.", + "description": "Output only. Whether the comment has been resolved by one of its replies.", "type": "boolean" } }, @@ -2679,7 +2767,7 @@ }, "kind": { "default": "drive#commentList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#commentList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#commentList\"`.", "type": "string" }, "nextPageToken": { @@ -2698,12 +2786,12 @@ "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.", + "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": "User", - "description": "The user who set the content restriction. Only populated if readOnly is true." + "description": "Output only. The user who set the content restriction. Only populated if `readOnly` is true." }, "restrictionTime": { "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.", @@ -2711,7 +2799,7 @@ "type": "string" }, "type": { - "description": "The type of the content restriction. Currently the only possible value is globalContentRestriction.", + "description": "Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.", "type": "string" } }, @@ -2722,7 +2810,7 @@ "id": "Drive", "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.", + "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.", "properties": { "id": { "description": "The ID of an image file in Google Drive to use for the background image.", @@ -2747,97 +2835,97 @@ "type": "object" }, "backgroundImageLink": { - "description": "A short-lived link to this shared drive's background image.", + "description": "Output only. A short-lived link to this shared drive's background image.", "type": "string" }, "capabilities": { - "description": "Capabilities the current user has on this shared drive.", + "description": "Output only. Capabilities the current user has on this shared drive.", "properties": { "canAddChildren": { - "description": "Whether the current user can add children to folders in this shared drive.", + "description": "Output only. Whether the current user can add children to folders in this shared drive.", "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { - "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.", + "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { - "description": "Whether the current user can change the domainUsersOnly restriction of this shared drive.", + "description": "Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.", "type": "boolean" }, "canChangeDriveBackground": { - "description": "Whether the current user can change the background of this shared drive.", + "description": "Output only. Whether the current user can change the background of this shared drive.", "type": "boolean" }, "canChangeDriveMembersOnlyRestriction": { - "description": "Whether the current user can change the driveMembersOnly restriction of this shared drive.", + "description": "Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.", "type": "boolean" }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { - "description": "Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive.", + "description": "Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.", "type": "boolean" }, "canComment": { - "description": "Whether the current user can comment on files in this shared drive.", + "description": "Output only. Whether the current user can comment on files in this shared drive.", "type": "boolean" }, "canCopy": { - "description": "Whether the current user can copy files in this shared drive.", + "description": "Output only. Whether the current user can copy files in this shared drive.", "type": "boolean" }, "canDeleteChildren": { - "description": "Whether the current user can delete children from folders in this shared drive.", + "description": "Output only. Whether the current user can delete children from folders in this shared drive.", "type": "boolean" }, "canDeleteDrive": { - "description": "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.", + "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": "Whether the current user can download files in this shared drive.", + "description": "Output only. Whether the current user can download files in this shared drive.", "type": "boolean" }, "canEdit": { - "description": "Whether the current user can edit files in this shared drive", + "description": "Output only. Whether the current user can edit files in this shared drive", "type": "boolean" }, "canListChildren": { - "description": "Whether the current user can list the children of folders in this shared drive.", + "description": "Output only. Whether the current user can list the children of folders in this shared drive.", "type": "boolean" }, "canManageMembers": { - "description": "Whether the current user can add members to this shared drive or remove them or change their role.", + "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": "Whether the current user can read the revisions resource of files in this shared drive.", + "description": "Output only. Whether the current user can read the revisions resource of files in this shared drive.", "type": "boolean" }, "canRename": { - "description": "Whether the current user can rename files or folders in this shared drive.", + "description": "Output only. Whether the current user can rename files or folders in this shared drive.", "type": "boolean" }, "canRenameDrive": { - "description": "Whether the current user can rename this shared drive.", + "description": "Output only. Whether the current user can rename this shared drive.", "type": "boolean" }, "canResetDriveRestrictions": { - "description": "Whether the current user can reset the shared drive restrictions to defaults.", + "description": "Output only. Whether the current user can reset the shared drive restrictions to defaults.", "type": "boolean" }, "canShare": { - "description": "Whether the current user can share files or folders in this shared drive.", + "description": "Output only. Whether the current user can share files or folders in this shared drive.", "type": "boolean" }, "canTrashChildren": { - "description": "Whether the current user can trash children from folders in this shared drive.", + "description": "Output only. Whether the current user can trash children from folders in this shared drive.", "type": "boolean" } }, "type": "object" }, "colorRgb": { - "description": "The color of this shared drive as an RGB hex string. It can only be set on drive.drives.update requests that don't set themeId.", + "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": { @@ -2850,25 +2938,20 @@ "type": "boolean" }, "id": { - "description": "The ID of this shared drive which is also the ID of the top level folder of this shared drive.", + "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": { "default": "drive#drive", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#drive\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#drive\"`.", "type": "string" }, "name": { - "annotations": { - "required": [ - "drive.drives.create" - ] - }, "description": "The name of this shared 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.", + "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": { @@ -2879,7 +2962,7 @@ "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.", + "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": { @@ -2898,7 +2981,7 @@ "type": "object" }, "themeId": { - "description": "The ID of the theme from which the background image and color are 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.", + "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" } }, @@ -2917,7 +3000,7 @@ }, "kind": { "default": "drive#driveList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#driveList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#driveList\"`.", "type": "string" }, "nextPageToken": { @@ -2935,162 +3018,162 @@ "additionalProperties": { "type": "string" }, - "description": "A collection of arbitrary key-value pairs that 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 an OAuth 2 client ID. You cannot use an API key to retrieve private properties.", + "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" }, "capabilities": { - "description": "Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user can take.", + "description": "Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.", "properties": { "canAcceptOwnership": { - "description": "Whether the current user is the pending owner of the file. Not populated for shared drive files.", + "description": "Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.", "type": "boolean" }, "canAddChildren": { - "description": "Whether the current user can add children to this folder. This is always false when the item isn't a folder.", + "description": "Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canAddFolderFromAnotherDrive": { - "description": "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.", + "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 is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canAddMyDriveParent": { - "description": "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.", + "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": "Whether the current user can change the copyRequiresWriterPermission restriction of this file.", + "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.", "type": "boolean" }, "canChangeSecurityUpdateEnabled": { - "description": "Whether the current user can change the securityUpdateEnabled field on link share metadata.", + "description": "Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.", "type": "boolean" }, "canChangeViewersCanCopyContent": { - "description": "Deprecated", + "description": "Deprecated: Output only.", "type": "boolean" }, "canComment": { - "description": "Whether the current user can comment on this file.", + "description": "Output only. Whether the current user can comment on this file.", "type": "boolean" }, "canCopy": { - "description": "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 itself if it's not a folder.", + "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 itself if it is not a folder.", "type": "boolean" }, "canDelete": { - "description": "Whether the current user can delete this file.", + "description": "Output only. Whether the current user can delete this file.", "type": "boolean" }, "canDeleteChildren": { - "description": "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.", + "description": "Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canDownload": { - "description": "Whether the current user can download this file.", + "description": "Output only. Whether the current user can download this file.", "type": "boolean" }, "canEdit": { - "description": "Whether the current user can edit this file. Other factors might limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.", + "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" }, "canListChildren": { - "description": "Whether the current user can list the children of this folder. This is always false when the item isn't a folder.", + "description": "Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canModifyContent": { - "description": "Whether the current user can modify the content of this file.", + "description": "Output only. Whether the current user can modify the content of this file.", "type": "boolean" }, "canModifyContentRestriction": { - "description": "Whether the current user can modify restrictions on content of this file.", + "description": "Output only. Whether the current user can modify restrictions on content of this file.", "type": "boolean" }, "canModifyLabels": { - "description": "Whether the current user can modify the labels on this file.", + "description": "Output only. Whether the current user can modify the labels on the file.", "type": "boolean" }, "canMoveChildrenOutOfDrive": { - "description": "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.", + "description": "Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canMoveChildrenOutOfTeamDrive": { - "description": "Deprecated - use canMoveChildrenOutOfDrive instead.", + "description": "Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.", "type": "boolean" }, "canMoveChildrenWithinDrive": { - "description": "Whether the current user can move children of this folder within this shared drive or My Drive. This is false when the item isn't a folder. Note that a request to move the child might still fail depending on the current user's access to the child and to the destination folder.", + "description": "Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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 - use canMoveChildrenWithinDrive instead.", + "description": "Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.", "type": "boolean" }, "canMoveItemIntoTeamDrive": { - "description": "Deprecated - use canMoveItemOutOfDrive instead.", + "description": "Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.", "type": "boolean" }, "canMoveItemOutOfDrive": { - "description": "Whether the current user can move this item outside of this shared drive or My Drive by changing its parent. Note that a request to change the parent of the item might still fail depending on the new parent that's being added.", + "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 is being added.", "type": "boolean" }, "canMoveItemOutOfTeamDrive": { - "description": "Deprecated - use canMoveItemOutOfDrive instead.", + "description": "Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.", "type": "boolean" }, "canMoveItemWithinDrive": { - "description": "Whether the current user can move this item within this shared drive or My Drive. Note that a request to change the parent of the item might still fail depending on the new parent that's being added and the parent that's being removed.", + "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 is being added and the parent that is being removed.", "type": "boolean" }, "canMoveItemWithinTeamDrive": { - "description": "Deprecated - use canMoveItemWithinDrive instead.", + "description": "Deprecated: Output only. Use `canMoveItemWithinDrive` instead.", "type": "boolean" }, "canMoveTeamDriveItem": { - "description": "Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.", + "description": "Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.", "type": "boolean" }, "canReadDrive": { - "description": "Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.", + "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": "Whether the current user can read the labels on this file.", + "description": "Output only. Whether the current user can read the labels on the file.", "type": "boolean" }, "canReadRevisions": { - "description": "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 itself if it's not a folder, can be read.", + "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 itself if it is not a folder, can be read.", "type": "boolean" }, "canReadTeamDrive": { - "description": "Deprecated - use canReadDrive instead.", + "description": "Deprecated: Output only. Use `canReadDrive` instead.", "type": "boolean" }, "canRemoveChildren": { - "description": "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.", + "description": "Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.", "type": "boolean" }, "canRemoveMyDriveParent": { - "description": "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.", + "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": "Whether the current user can rename this file.", + "description": "Output only. Whether the current user can rename this file.", "type": "boolean" }, "canShare": { - "description": "Whether the current user can modify the sharing settings for this file.", + "description": "Output only. Whether the current user can modify the sharing settings for this file.", "type": "boolean" }, "canTrash": { - "description": "Whether the current user can move this file to trash.", + "description": "Output only. Whether the current user can move this file to trash.", "type": "boolean" }, "canTrashChildren": { - "description": "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.", + "description": "Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canUntrash": { - "description": "Whether the current user can restore this file from trash.", + "description": "Output only. Whether the current user can restore this file from trash.", "type": "boolean" } }, @@ -3100,7 +3183,7 @@ "description": "Additional information about the content of the file. These fields are never populated in responses.", "properties": { "indexableText": { - "description": "Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and might contain HTML elements. For more information, see Manage file metadata.", + "description": "Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.", "type": "string" }, "thumbnail": { @@ -3142,48 +3225,47 @@ "type": "string" }, "driveId": { - "description": "ID of the shared drive the file resides in. Only populated for items in shared drives.", + "description": "Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.", "type": "string" }, "explicitlyTrashed": { - "description": "Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.", + "description": "Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.", "type": "boolean" }, "exportLinks": { "additionalProperties": { - "description": "A mapping from export format to URL", "type": "string" }, - "description": "Links for exporting Docs Editors files to specific formats.", + "description": "Output only. Links for exporting Docs Editors files to specific formats.", "readOnly": true, "type": "object" }, "fileExtension": { - "description": "The final component of fullFileExtension. This is only available for files with binary content in Google Drive.", + "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 shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.\nIf an unsupported color is specified, the closest color in the palette will be used instead.", + "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 resource. If an unsupported color is specified, the closest color in the palette is used instead.", "type": "string" }, "fullFileExtension": { - "description": "The full file extension extracted from the name field. Can contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive.\nThis is automatically updated when the name field changes, however it's not cleared if the new name does not contain a valid extension.", + "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 is not cleared if the new name does not contain a valid extension.", "type": "string" }, "hasAugmentedPermissions": { - "description": "Whether there are permissions directly on this file. This field is only populated for items in shared drives.", + "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": "Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", + "description": "Output only. Whether this file has a thumbnail. This does not 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": "The ID of the file's head revision. This is only available for files with binary content in Google Drive.", + "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": "A static, unauthenticated link to the file's icon.", + "description": "Output only. A static, unauthenticated link to the file's icon.", "type": "string" }, "id": { @@ -3191,77 +3273,77 @@ "type": "string" }, "imageMediaMetadata": { - "description": "Additional metadata about image media, if available.", + "description": "Output only. Additional metadata about image media, if available.", "properties": { "aperture": { - "description": "The aperture used to create the photo (f-number).", + "description": "Output only. The aperture used to create the photo (f-number).", "format": "float", "type": "number" }, "cameraMake": { - "description": "The make of the camera used to create the photo.", + "description": "Output only. The make of the camera used to create the photo.", "type": "string" }, "cameraModel": { - "description": "The model of the camera used to create the photo.", + "description": "Output only. The model of the camera used to create the photo.", "type": "string" }, "colorSpace": { - "description": "The color space of the photo.", + "description": "Output only. The color space of the photo.", "type": "string" }, "exposureBias": { - "description": "The exposure bias of the photo (APEX value).", + "description": "Output only. The exposure bias of the photo (APEX value).", "format": "float", "type": "number" }, "exposureMode": { - "description": "The exposure mode used to create the photo.", + "description": "Output only. The exposure mode used to create the photo.", "type": "string" }, "exposureTime": { - "description": "The length of the exposure, in seconds.", + "description": "Output only. The length of the exposure, in seconds.", "format": "float", "type": "number" }, "flashUsed": { - "description": "Whether a flash was used to create the photo.", + "description": "Output only. Whether a flash was used to create the photo.", "type": "boolean" }, "focalLength": { - "description": "The focal length used to create the photo, in millimeters.", + "description": "Output only. The focal length used to create the photo, in millimeters.", "format": "float", "type": "number" }, "height": { - "description": "The height of the image in pixels.", + "description": "Output only. The height of the image in pixels.", "format": "int32", "type": "integer" }, "isoSpeed": { - "description": "The ISO speed used to create the photo.", + "description": "Output only. The ISO speed used to create the photo.", "format": "int32", "type": "integer" }, "lens": { - "description": "The lens used to create the photo.", + "description": "Output only. The lens used to create the photo.", "type": "string" }, "location": { - "description": "Geographic location information stored in the image.", + "description": "Output only. Geographic location information stored in the image.", "properties": { "altitude": { - "description": "The altitude stored in the image.", + "description": "Output only. The altitude stored in the image.", "format": "double", "type": "number" }, "latitude": { - "description": "The latitude stored in the image.", + "description": "Output only. The latitude stored in the image.", "format": "double", "type": "number" }, "longitude": { - "description": "The longitude stored in the image.", + "description": "Output only. The longitude stored in the image.", "format": "double", "type": "number" } @@ -3269,38 +3351,38 @@ "type": "object" }, "maxApertureValue": { - "description": "The smallest f-number of the lens at the focal length used to create the photo (APEX value).", + "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": "The metering mode used to create the photo.", + "description": "Output only. The metering mode used to create the photo.", "type": "string" }, "rotation": { - "description": "The number of clockwise 90-degree rotations applied from the image's original orientation.", + "description": "Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.", "format": "int32", "type": "integer" }, "sensor": { - "description": "The type of sensor used to create the photo.", + "description": "Output only. The type of sensor used to create the photo.", "type": "string" }, "subjectDistance": { - "description": "The distance to the subject of the photo, in meters.", + "description": "Output only. The distance to the subject of the photo, in meters.", "format": "int32", "type": "integer" }, "time": { - "description": "The date and time the photo was taken (EXIF DateTime).", + "description": "Output only. The date and time the photo was taken (EXIF DateTime).", "type": "string" }, "whiteBalance": { - "description": "The white balance mode used to create the photo.", + "description": "Output only. The white balance mode used to create the photo.", "type": "string" }, "width": { - "description": "The width of the image in pixels.", + "description": "Output only. The width of the image in pixels.", "format": "int32", "type": "integer" } @@ -3308,19 +3390,19 @@ "type": "object" }, "isAppAuthorized": { - "description": "Whether the requesting app created or opened the file.", + "description": "Output only. Whether the file was created or opened by the requesting app.", "type": "boolean" }, "kind": { "default": "drive#file", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#file\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#file\"`.", "type": "string" }, "labelInfo": { - "description": "An overview of the labels on the file.", + "description": "Output only. An overview of the labels on the file.", "properties": { "labels": { - "description": "The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned.", + "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.", "items": { "$ref": "Label" }, @@ -3331,79 +3413,79 @@ }, "lastModifyingUser": { "$ref": "User", - "description": "The last user to modify the file." + "description": "Output only. The last user to modify the file." }, "linkShareMetadata": { "description": "Contains details about the link URLs that clients are using to refer to this item.", "properties": { "securityUpdateEligible": { - "description": "Whether the file is eligible for security update.", + "description": "Output only. Whether the file is eligible for security update.", "type": "boolean" }, "securityUpdateEnabled": { - "description": "Whether the security update is enabled for this file.", + "description": "Output only. Whether the security update is enabled for this file.", "type": "boolean" } }, "type": "object" }, "md5Checksum": { - "description": "The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.", + "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.\nGoogle Drive will attempt 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.\nIf a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.", + "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 resource.", "type": "string" }, "modifiedByMe": { - "description": "Whether this user has modified the file.", + "description": "Output only. Whether the file has been modified by this user.", "type": "boolean" }, "modifiedByMeTime": { - "description": "The last time the user modified the file (RFC 3339 date-time).", + "description": "The last time the file was modified by the user (RFC 3339 date-time).", "format": "date-time", "type": "string" }, "modifiedTime": { - "description": "The last time anyone modified the file (RFC 3339 date-time).\nNote that setting modifiedTime will also update modifiedByMeTime for the user.", + "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, My Drive root folder, and Application Data folder the name is constant.", + "description": "The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and 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.", + "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": "Whether the user owns the file. Not populated for items in shared drives.", + "description": "Output only. Whether the user owns the file. Not populated for items in shared drives.", "type": "boolean" }, "owners": { - "description": "The owner of this file. Only certain legacy files might have more than one owner. This field isn't populated for items in shared drives.", + "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.", "items": { "$ref": "User" }, "type": "array" }, "parents": { - "description": "The IDs of the parent folders that contain the file.\nIf not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.", + "description": "The IDs of the parent folders which contain the file. 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 parents of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.", "items": { "type": "string" }, "type": "array" }, "permissionIds": { - "description": "List of permission IDs for users with access to this file.", + "description": "Output only. List of permission IDs for users with access to this file.", "items": { "type": "string" }, "type": "array" }, "permissions": { - "description": "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.", + "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.", "items": { "$ref": "Permission" }, @@ -3413,28 +3495,28 @@ "additionalProperties": { "type": "string" }, - "description": "A collection of arbitrary key-value pairs that are visible to all apps.\nEntries with null values are cleared in update and copy requests.", + "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" }, "quotaBytesUsed": { - "description": "The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.", + "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": "A key needed to access the item via a shared link.", + "description": "Output only. A key needed to access the item via a shared link.", "type": "string" }, "sha1Checksum": { - "description": "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.", + "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 is not populated for Docs Editors or shortcut files.", "type": "string" }, "sha256Checksum": { - "description": "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.", + "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 is not populated for Docs Editors or shortcut files.", "type": "string" }, "shared": { - "description": "Whether the file has been shared. Not populated for items in shared drives.", + "description": "Output only. Whether the file has been shared. Not populated for items in shared drives.", "type": "boolean" }, "sharedWithMeTime": { @@ -3444,33 +3526,33 @@ }, "sharingUser": { "$ref": "User", - "description": "The user who shared the file with the requesting user, if applicable." + "description": "Output only. The user who shared the file with the requesting user, if applicable." }, "shortcutDetails": { - "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.", + "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`.", "properties": { "targetId": { "description": "The ID of the file that this shortcut points to.", "type": "string" }, "targetMimeType": { - "description": "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.", + "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": "The ResourceKey for the target file.", + "description": "Output only. The ResourceKey for the target file.", "type": "string" } }, "type": "object" }, "size": { - "description": "The size of the file's content in bytes. This field is populated for files with binary content stored in Google Drive and for Docs Editors files; it's not populated for shortcuts or folders.", + "description": "Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.", "format": "int64", "type": "string" }, "spaces": { - "description": "The list of spaces that contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.", + "description": "Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.", "items": { "type": "string" }, @@ -3481,20 +3563,20 @@ "type": "boolean" }, "teamDriveId": { - "description": "Deprecated - use driveId instead.", + "description": "Deprecated: Output only. Use `driveId` instead.", "type": "string" }, "thumbnailLink": { - "description": "A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. 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.", + "description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.", "type": "string" }, "thumbnailVersion": { - "description": "The thumbnail version for use in thumbnail cache invalidation.", + "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 can trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.", + "description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.", "type": "boolean" }, "trashedTime": { @@ -3504,28 +3586,28 @@ }, "trashingUser": { "$ref": "User", - "description": "If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives." + "description": "Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives." }, "version": { - "description": "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.", + "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": "Additional metadata about video media. This might not be available immediately upon upload.", + "description": "Output only. Additional metadata about video media. This may not be available immediately upon upload.", "properties": { "durationMillis": { - "description": "The duration of the video in milliseconds.", + "description": "Output only. The duration of the video in milliseconds.", "format": "int64", "type": "string" }, "height": { - "description": "The height of the video in pixels.", + "description": "Output only. The height of the video in pixels.", "format": "int32", "type": "integer" }, "width": { - "description": "The width of the video in pixels.", + "description": "Output only. The width of the video in pixels.", "format": "int32", "type": "integer" } @@ -3533,28 +3615,28 @@ "type": "object" }, "viewedByMe": { - "description": "Whether this user has viewed the file.", + "description": "Output only. Whether the file has been viewed by this user.", "type": "boolean" }, "viewedByMeTime": { - "description": "The last time the user viewed the file (RFC 3339 date-time).", + "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.", + "description": "Deprecated: Use `copyRequiresWriterPermission` instead.", "type": "boolean" }, "webContentLink": { - "description": "A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.", + "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": "A link for opening the file in a relevant Google editor or viewer in a browser.", + "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.", + "description": "Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.", "type": "boolean" } }, @@ -3577,7 +3659,7 @@ }, "kind": { "default": "drive#fileList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#fileList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#fileList\"`.", "type": "string" }, "nextPageToken": { @@ -3600,7 +3682,7 @@ }, "kind": { "default": "drive#generatedIds", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#generatedIds\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#generatedIds\"`.", "type": "string" }, "space": { @@ -3611,14 +3693,14 @@ "type": "object" }, "Label": { - "description": "Representation of a label and its fields.", + "description": "Representation of label and label fields.", "id": "Label", "properties": { "fields": { "additionalProperties": { "$ref": "LabelField" }, - "description": "A map of the label's fields keyed by the field ID.", + "description": "A map of the fields on the label, keyed by the field's ID.", "type": "object" }, "id": { @@ -3626,7 +3708,6 @@ "type": "string" }, "kind": { - "default": "drive#label", "description": "This is always drive#label", "type": "string" }, @@ -3638,7 +3719,7 @@ "type": "object" }, "LabelField": { - "description": "Representation of a label field.", + "description": "Representation of field, which is a typed key-value pair.", "id": "LabelField", "properties": { "dateString": { @@ -3650,11 +3731,11 @@ "type": "array" }, "id": { - "description": "The identifier of this field.", + "description": "The identifier of this label field.", "type": "string" }, "integer": { - "description": "Only present if valueType is integer.", + "description": "Only present if `valueType` is `integer`.", "items": { "format": "int64", "type": "string" @@ -3662,33 +3743,32 @@ "type": "array" }, "kind": { - "default": "drive#labelField", "description": "This is always drive#labelField.", "type": "string" }, "selection": { - "description": "Only present if valueType is selection.", + "description": "Only present if `valueType` is `selection`", "items": { "type": "string" }, "type": "array" }, "text": { - "description": "Only present if valueType is text.", + "description": "Only present if `valueType` is `text`.", "items": { "type": "string" }, "type": "array" }, "user": { - "description": "Only present if valueType is user.", + "description": "Only present if `valueType` is `user`.", "items": { "$ref": "User" }, "type": "array" }, "valueType": { - "description": "The field type. While new values may be supported in the future, the following are currently allowed: \n- dateString \n- integer \n- selection \n- text \n- user", + "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" } }, @@ -3699,16 +3779,15 @@ "id": "LabelFieldModification", "properties": { "fieldId": { - "description": "The ID of the Field to be modified.", + "description": "The ID of the field to be modified.", "type": "string" }, "kind": { - "default": "drive#labelFieldModification", "description": "This is always drive#labelFieldModification.", "type": "string" }, "setDateValues": { - "description": "Replaces a dateString field with these new values. The values must be strings in the RFC 3339 full-date format: YYYY-MM-DD.", + "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.", "items": { "format": "date", "type": "string" @@ -3716,7 +3795,7 @@ "type": "array" }, "setIntegerValues": { - "description": "Replaces an integer field with these new values.", + "description": "Replaces the value of an `integer` field with these new values.", "items": { "format": "int64", "type": "string" @@ -3724,21 +3803,21 @@ "type": "array" }, "setSelectionValues": { - "description": "Replaces a selection field with these new values.", + "description": "Replaces a `selection` field with these new values.", "items": { "type": "string" }, "type": "array" }, "setTextValues": { - "description": "Replaces a text field with these new values.", + "description": "Sets the value of a `text` field.", "items": { "type": "string" }, "type": "array" }, "setUserValues": { - "description": "Replaces a user field with these new values. The values must be valid email addresses.", + "description": "Replaces a `user` field with these new values. The values must be valid email addresses.", "items": { "type": "string" }, @@ -3752,11 +3831,10 @@ "type": "object" }, "LabelList": { - "description": "A list of labels.", + "description": "A list of labels applied to a file.", "id": "LabelList", "properties": { "kind": { - "default": "drive#labelList", "description": "This is always drive#labelList", "type": "string" }, @@ -3786,7 +3864,6 @@ "type": "array" }, "kind": { - "default": "drive#labelModification", "description": "This is always drive#labelModification.", "type": "string" }, @@ -3807,12 +3884,11 @@ "type": "object" }, "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 transactionally.", + "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.", "id": "ModifyLabelsRequest", "properties": { "kind": { - "default": "drive#modifyLabelsRequest", - "description": "This is always drive#modifyLabelsRequest", + "description": "This is always drive#modifyLabelsRequest.", "type": "string" }, "labelModifications": { @@ -3830,7 +3906,6 @@ "id": "ModifyLabelsResponse", "properties": { "kind": { - "default": "drive#modifyLabelsResponse", "description": "This is always drive#modifyLabelsResponse", "type": "string" }, @@ -3845,23 +3920,23 @@ "type": "object" }, "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.", + "description": "A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.", "id": "Permission", "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.", + "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": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", + "description": "Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", "type": "boolean" }, "displayName": { - "description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: \n- user - User's full name, as defined for their Google Account, such as \"Joe Smith.\" \n- group - Name of the Google Group, such as \"The Company Administrators.\" \n- domain - String domain name, such as \"your-company.com.\" \n- anyone - No displayName is present.", + "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 \"Joe Smith.\" * `group` - Name of the Google Group, such as \"The Company Administrators.\" * `domain` - String domain name, such as \"thecompany.com.\" * `anyone` - No `displayName` is present.", "type": "string" }, "domain": { - "description": "The domain to which this permission refers. The following options are currently allowed: \n- The entire domain, such as \"your-company.com.\" \n- A target audience, such as \"ID.audience.googledomains.com.\"", + "description": "The domain to which this permission refers.", "type": "string" }, "emailAddress": { @@ -3869,41 +3944,41 @@ "type": "string" }, "expirationTime": { - "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: \n- They cannot be set on shared drive items. \n- They can only be set on user and group permissions. \n- The time must be in the future. \n- The time cannot be more than one year in the future.", + "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": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.", + "description": "Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.", "type": "string" }, "kind": { "default": "drive#permission", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#permission\"`.", "type": "string" }, "pendingOwner": { - "description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive.", + "description": "Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.", "type": "boolean" }, "permissionDetails": { - "description": "Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items.", + "description": "Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", "items": { "properties": { "inherited": { - "description": "Whether this permission is inherited. This field is always populated. This is an output-only field.", + "description": "Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.", "type": "boolean" }, "inheritedFrom": { - "description": "The ID of the item from which this permission is inherited. This is an output-only field.", + "description": "Output only. The ID of the item from which this permission is inherited. This is an output-only field.", "type": "string" }, "permissionType": { - "description": "The permission type for this user. While new values may be added in future, the following are currently allowed: \n- file \n- member", + "description": "Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`", "type": "string" }, "role": { - "description": "The primary role for this user. While new values may be added in the future, the following are currently allowed: \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", + "description": "Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`", "type": "string" } }, @@ -3913,7 +3988,7 @@ "type": "array" }, "photoLink": { - "description": "A link to the user's profile photo, if available.", + "description": "Output only. A link to the user's profile photo, if available.", "type": "string" }, "role": { @@ -3922,27 +3997,27 @@ "drive.permissions.create" ] }, - "description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: \n- owner \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", + "description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`", "type": "string" }, "teamDrivePermissionDetails": { - "description": "Deprecated - use permissionDetails instead.", + "description": "Output only. Deprecated: Output only. Use `permissionDetails` instead.", "items": { "properties": { "inherited": { - "description": "Deprecated - use permissionDetails/inherited instead.", + "description": "Deprecated: Output only. Use `permissionDetails/inherited` instead.", "type": "boolean" }, "inheritedFrom": { - "description": "Deprecated - use permissionDetails/inheritedFrom instead.", + "description": "Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.", "type": "string" }, "role": { - "description": "Deprecated - use permissionDetails/role instead.", + "description": "Deprecated: Output only. Use `permissionDetails/role` instead.", "type": "string" }, "teamDrivePermissionType": { - "description": "Deprecated - use permissionDetails/permissionType instead.", + "description": "Deprecated: Output only. Use `permissionDetails/permissionType` instead.", "type": "string" } }, @@ -3957,11 +4032,11 @@ "drive.permissions.create" ] }, - "description": "The type of the grantee. Valid values are: \n- user \n- group \n- domain \n- anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for the anyone type.", + "description": "The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type.", "type": "string" }, "view": { - "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.", + "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.", "type": "string" } }, @@ -3973,7 +4048,7 @@ "properties": { "kind": { "default": "drive#permissionList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permissionList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#permissionList\"`.", "type": "string" }, "nextPageToken": { @@ -3995,12 +4070,12 @@ "id": "Reply", "properties": { "action": { - "description": "The action the reply performed to the parent comment. Valid values are: \n- resolve \n- reopen", + "description": "The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen`", "type": "string" }, "author": { "$ref": "User", - "description": "The author of the reply. The author's email address and permission ID will not be populated." + "description": "Output only. The author of the reply. The author's email address and permission ID will not be populated." }, "content": { "annotations": { @@ -4008,7 +4083,7 @@ "drive.replies.update" ] }, - "description": "The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.", + "description": "The plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This is required on creates if no `action` is specified.", "type": "string" }, "createdTime": { @@ -4017,20 +4092,20 @@ "type": "string" }, "deleted": { - "description": "Whether the reply has been deleted. A deleted reply has no content.", + "description": "Output only. Whether the reply has been deleted. A deleted reply has no content.", "type": "boolean" }, "htmlContent": { - "description": "The content of the reply with HTML formatting.", + "description": "Output only. The content of the reply with HTML formatting.", "type": "string" }, "id": { - "description": "The ID of the reply.", + "description": "Output only. The ID of the reply.", "type": "string" }, "kind": { "default": "drive#reply", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#reply\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#reply\"`.", "type": "string" }, "modifiedTime": { @@ -4047,7 +4122,7 @@ "properties": { "kind": { "default": "drive#replyList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#replyList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#replyList\"`.", "type": "string" }, "nextPageToken": { @@ -4070,35 +4145,34 @@ "properties": { "exportLinks": { "additionalProperties": { - "description": "A mapping from export format to URL", "type": "string" }, - "description": "Links for exporting Docs Editors files to specific formats.", + "description": "Output only. Links for exporting Docs Editors files to specific formats.", "type": "object" }, "id": { - "description": "The ID of the revision.", + "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.\nThis field is only applicable to files with binary content in Drive.", + "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": { "default": "drive#revision", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#revision\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#revision\"`.", "type": "string" }, "lastModifyingUser": { "$ref": "User", - "description": "The last user to modify this revision." + "description": "Output only. The last user to modify this revision." }, "md5Checksum": { - "description": "The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.", + "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": "The MIME type of the revision.", + "description": "Output only. The MIME type of the revision.", "type": "string" }, "modifiedTime": { @@ -4107,7 +4181,7 @@ "type": "string" }, "originalFilename": { - "description": "The original filename used to create this revision. This is only applicable to files with binary content in Drive.", + "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": { @@ -4119,7 +4193,7 @@ "type": "boolean" }, "publishedLink": { - "description": "A link to the published revision. This is only populated for Google Sites files.", + "description": "Output only. A link to the published revision. This is only populated for Google Sites files.", "type": "string" }, "publishedOutsideDomain": { @@ -4127,7 +4201,7 @@ "type": "boolean" }, "size": { - "description": "The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.", + "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" } @@ -4140,7 +4214,7 @@ "properties": { "kind": { "default": "drive#revisionList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#revisionList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#revisionList\"`.", "type": "string" }, "nextPageToken": { @@ -4162,7 +4236,7 @@ "properties": { "kind": { "default": "drive#startPageToken", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#startPageToken\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#startPageToken\"`.", "type": "string" }, "startPageToken": { @@ -4177,7 +4251,7 @@ "id": "TeamDrive", "properties": { "backgroundImageFile": { - "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.", + "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.", "properties": { "id": { "description": "The ID of an image file in Drive to use for the background image.", @@ -4213,15 +4287,15 @@ "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { - "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.", + "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.", + "description": "Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.", "type": "boolean" }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { - "description": "Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this Team Drive.", + "description": "Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.", "type": "boolean" }, "canChangeTeamDriveBackground": { @@ -4229,7 +4303,7 @@ "type": "boolean" }, "canChangeTeamMembersOnlyRestriction": { - "description": "Whether the current user can change the teamMembersOnly restriction of this Team Drive.", + "description": "Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.", "type": "boolean" }, "canComment": { @@ -4269,7 +4343,7 @@ "type": "boolean" }, "canRemoveChildren": { - "description": "Deprecated - use canDeleteChildren or canTrashChildren instead.", + "description": "Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.", "type": "boolean" }, "canRename": { @@ -4296,7 +4370,7 @@ "type": "object" }, "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.", + "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": { @@ -4310,20 +4384,15 @@ }, "kind": { "default": "drive#teamDrive", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#teamDrive\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDrive\"`.", "type": "string" }, "name": { - "annotations": { - "required": [ - "drive.teamdrives.create" - ] - }, "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.", + "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": { @@ -4334,7 +4403,7 @@ "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.", + "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": { @@ -4353,7 +4422,7 @@ "type": "object" }, "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.", + "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" } }, @@ -4365,7 +4434,7 @@ "properties": { "kind": { "default": "drive#teamDriveList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#teamDriveList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDriveList\"`.", "type": "string" }, "nextPageToken": { @@ -4387,35 +4456,35 @@ "id": "User", "properties": { "displayName": { - "description": "A plain text displayable name for this user.", + "description": "Output only. A plain text displayable name for this user.", "type": "string" }, "emailAddress": { - "description": "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.", + "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.", "type": "string" }, "kind": { "default": "drive#user", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#user\"`.", "type": "string" }, "me": { - "description": "Whether this user is the requesting user.", + "description": "Output only. Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { - "description": "The user's ID as visible in Permission resources.", + "description": "Output only. The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { - "description": "A link to the user's profile photo, if available.", + "description": "Output only. A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" } }, - "servicePath": "drive/v3/", - "title": "Drive API", + "servicePath": "", + "title": "Google Drive API", "version": "v3" } \ No newline at end of file diff --git a/drive/v3/drive-gen.go b/drive/v3/drive-gen.go index b538a712f20..16f3c62d61b 100644 --- a/drive/v3/drive-gen.go +++ b/drive/v3/drive-gen.go @@ -4,7 +4,7 @@ // Code generated file. DO NOT EDIT. -// Package drive provides access to the Drive API. +// Package drive provides access to the Google Drive API. // // For product documentation, see: https://developers.google.com/drive/ // @@ -80,7 +80,8 @@ var _ = internal.Version const apiId = "drive:v3" const apiName = "drive" const apiVersion = "v3" -const basePath = "https://www.googleapis.com/drive/v3/" +const basePath = "https://www.googleapis.com/" +const mtlsBasePath = "https://www.mtls.googleapis.com/" // OAuth2 scopes used by this API. const ( @@ -126,6 +127,7 @@ func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, err // NOTE: prepend, so we don't override user-specified scopes. opts = append([]option.ClientOption{scopesOption}, opts...) opts = append(opts, internaloption.WithDefaultEndpoint(basePath)) + opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath)) client, endpoint, err := htransport.NewClient(ctx, opts...) if err != nil { return nil, err @@ -295,7 +297,7 @@ type About struct { // CanCreateDrives: Whether the user can create shared drives. CanCreateDrives bool `json:"canCreateDrives,omitempty"` - // CanCreateTeamDrives: Deprecated - use canCreateDrives instead. + // CanCreateTeamDrives: Deprecated: Use `canCreateDrives` instead. CanCreateTeamDrives bool `json:"canCreateTeamDrives,omitempty"` // DriveThemes: A list of themes that are supported for shared drives. @@ -327,7 +329,7 @@ type About struct { // are measured in bytes. StorageQuota *AboutStorageQuota `json:"storageQuota,omitempty"` - // TeamDriveThemes: Deprecated - use driveThemes instead. + // TeamDriveThemes: Deprecated: Use `driveThemes` instead. TeamDriveThemes []*AboutTeamDriveThemes `json:"teamDriveThemes,omitempty"` // User: The authenticated user. @@ -434,14 +436,14 @@ func (s *AboutStorageQuota) MarshalJSON() ([]byte, error) { } type AboutTeamDriveThemes struct { - // BackgroundImageLink: Deprecated - use driveThemes/backgroundImageLink - // instead. + // BackgroundImageLink: Deprecated: Use + // `driveThemes/backgroundImageLink` instead. BackgroundImageLink string `json:"backgroundImageLink,omitempty"` - // ColorRgb: Deprecated - use driveThemes/colorRgb instead. + // ColorRgb: Deprecated: Use `driveThemes/colorRgb` instead. ColorRgb string `json:"colorRgb,omitempty"` - // Id: Deprecated - use driveThemes/id instead. + // Id: Deprecated: Use `driveThemes/id` instead. Id string `json:"id,omitempty"` // ForceSendFields is a list of field names (e.g. "BackgroundImageLink") @@ -470,8 +472,8 @@ func (s *AboutTeamDriveThemes) MarshalJSON() ([]byte, error) { // Change: A change to a file or shared drive. type Change struct { - // ChangeType: The type of the change. Possible values are file and - // drive. + // ChangeType: The type of the change. Possible values are `file` and + // `drive`. ChangeType string `json:"changeType,omitempty"` // Drive: The updated state of the shared drive. Present if the @@ -497,16 +499,16 @@ type Change struct { // list of changes, for example by deletion or loss of access. Removed bool `json:"removed,omitempty"` - // TeamDrive: Deprecated - use drive instead. + // TeamDrive: Deprecated: Use `drive` instead. TeamDrive *TeamDrive `json:"teamDrive,omitempty"` - // TeamDriveId: Deprecated - use driveId instead. + // TeamDriveId: Deprecated: Use `driveId` instead. TeamDriveId string `json:"teamDriveId,omitempty"` // Time: The time of this change (RFC 3339 date-time). Time string `json:"time,omitempty"` - // Type: Deprecated - use changeType instead. + // Type: Deprecated: Use `changeType` instead. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "ChangeType") to @@ -581,7 +583,7 @@ func (s *ChangeList) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Channel: An notification channel used to watch for resource changes. +// Channel: A notification channel used to watch for resource changes. type Channel struct { // Address: The address where notifications are delivered for this // channel. @@ -595,7 +597,7 @@ type Channel struct { Id string `json:"id,omitempty"` // Kind: Identifies this as a notification channel used to watch for - // changes to a resource, which is "api#channel". + // changes to a resource, which is `api#channel`. Kind string `json:"kind,omitempty"` // Params: Additional parameters controlling delivery channel behavior. @@ -617,9 +619,7 @@ type Channel struct { // notification delivered over this channel. Optional. Token string `json:"token,omitempty"` - // Type: 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: The type of delivery mechanism used for this channel. Type string `json:"type,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -652,34 +652,35 @@ func (s *Channel) MarshalJSON() ([]byte, error) { // Comment: A comment on a file. type Comment struct { // Anchor: A region of the document represented as a JSON string. For - // details on defining anchor properties, refer to Add comments and - // replies. + // details on defining anchor properties, refer to Manage comments and + // replies (https://developers.google.com/drive/api/v3/manage-comments). Anchor string `json:"anchor,omitempty"` - // Author: The author of the comment. The author's email address and - // permission ID will not be populated. + // Author: Output only. The author of the comment. The author's email + // address and permission ID will not be populated. Author *User `json:"author,omitempty"` // Content: The plain text content of the comment. This field is used - // for setting the content, while htmlContent should be displayed. + // for setting the content, while `htmlContent` should be displayed. Content string `json:"content,omitempty"` // CreatedTime: The time at which the comment was created (RFC 3339 // date-time). CreatedTime string `json:"createdTime,omitempty"` - // Deleted: Whether the comment has been deleted. A deleted comment has - // no content. + // Deleted: Output only. Whether the comment has been deleted. A deleted + // comment has no content. Deleted bool `json:"deleted,omitempty"` - // HtmlContent: The content of the comment with HTML formatting. + // HtmlContent: Output only. The content of the comment with HTML + // formatting. HtmlContent string `json:"htmlContent,omitempty"` - // Id: The ID of the comment. + // Id: Output only. The ID of the comment. Id string `json:"id,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#comment". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#comment". Kind string `json:"kind,omitempty"` // ModifiedTime: The last time the comment or any of its replies was @@ -691,12 +692,12 @@ type Comment struct { // this would be the text at the location of the comment. QuotedFileContent *CommentQuotedFileContent `json:"quotedFileContent,omitempty"` - // Replies: The full list of replies to the comment in chronological - // order. + // Replies: Output only. The full list of replies to the comment in + // chronological order. Replies []*Reply `json:"replies,omitempty"` - // Resolved: Whether the comment has been resolved by one of its - // replies. + // Resolved: Output only. Whether the comment has been resolved by one + // of its replies. Resolved bool `json:"resolved,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -814,19 +815,19 @@ type ContentRestriction struct { ReadOnly bool `json:"readOnly,omitempty"` // Reason: Reason for why the content of the file is restricted. This is - // only mutable on requests that also set readOnly=true. + // only mutable on requests that also set `readOnly=true`. Reason string `json:"reason,omitempty"` - // RestrictingUser: The user who set the content restriction. Only - // populated if readOnly is true. + // RestrictingUser: Output only. The user who set the content + // restriction. Only populated if `readOnly` is true. RestrictingUser *User `json:"restrictingUser,omitempty"` // RestrictionTime: The time at which the content restriction was set // (formatted RFC 3339 timestamp). Only populated if readOnly is true. RestrictionTime string `json:"restrictionTime,omitempty"` - // Type: The type of the content restriction. Currently the only - // possible value is globalContentRestriction. + // Type: Output only. The type of the content restriction. Currently the + // only possible value is `globalContentRestriction`. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "ReadOnly") to @@ -855,21 +856,23 @@ func (s *ContentRestriction) MarshalJSON() ([]byte, error) { // Drive: Representation of a shared drive. type Drive struct { // BackgroundImageFile: 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. + // 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. BackgroundImageFile *DriveBackgroundImageFile `json:"backgroundImageFile,omitempty"` - // BackgroundImageLink: A short-lived link to this shared drive's - // background image. + // BackgroundImageLink: Output only. A short-lived link to this shared + // drive's background image. BackgroundImageLink string `json:"backgroundImageLink,omitempty"` - // Capabilities: Capabilities the current user has on this shared drive. + // Capabilities: Output only. Capabilities the current user has on this + // shared drive. Capabilities *DriveCapabilities `json:"capabilities,omitempty"` // ColorRgb: The color of this shared drive as an RGB hex string. It can - // only be set on drive.drives.update requests that don't set themeId. + // only be set on a `drive.drives.update` request that does not set + // `themeId`. ColorRgb string `json:"colorRgb,omitempty"` // CreatedTime: The time at which the shared drive was created (RFC 3339 @@ -879,20 +882,20 @@ type Drive struct { // Hidden: Whether the shared drive is hidden from default view. Hidden bool `json:"hidden,omitempty"` - // Id: The ID of this shared drive which is also the ID of the top level - // folder of this shared drive. + // Id: Output only. The ID of this shared drive which is also the ID of + // the top level folder of this shared drive. Id string `json:"id,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#drive". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#drive". Kind string `json:"kind,omitempty"` // Name: The name of this shared drive. Name string `json:"name,omitempty"` - // OrgUnitId: The organizational unit of this shared drive. This field - // is only populated on drives.list responses when the - // useDomainAdminAccess parameter is set to true. + // OrgUnitId: 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`. OrgUnitId string `json:"orgUnitId,omitempty"` // Restrictions: A set of restrictions that apply to this shared drive @@ -900,12 +903,12 @@ type Drive struct { Restrictions *DriveRestrictions `json:"restrictions,omitempty"` // ThemeId: The ID of the theme from which the background image and - // color are 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. + // 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`. ThemeId string `json:"themeId,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -938,9 +941,9 @@ func (s *Drive) MarshalJSON() ([]byte, error) { // DriveBackgroundImageFile: 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. +// 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 DriveBackgroundImageFile struct { // Id: The ID of an image file in Google Drive to use for the background // image. @@ -1008,90 +1011,93 @@ func (s *DriveBackgroundImageFile) UnmarshalJSON(data []byte) error { return nil } -// DriveCapabilities: Capabilities the current user has on this shared -// drive. +// DriveCapabilities: Output only. Capabilities the current user has on +// this shared drive. type DriveCapabilities struct { - // CanAddChildren: Whether the current user can add children to folders - // in this shared drive. + // CanAddChildren: Output only. Whether the current user can add + // children to folders in this shared drive. CanAddChildren bool `json:"canAddChildren,omitempty"` - // CanChangeCopyRequiresWriterPermissionRestriction: Whether the current - // user can change the copyRequiresWriterPermission restriction of this - // shared drive. + // CanChangeCopyRequiresWriterPermissionRestriction: Output only. + // Whether the current user can change the + // `copyRequiresWriterPermission` restriction of this shared drive. CanChangeCopyRequiresWriterPermissionRestriction bool `json:"canChangeCopyRequiresWriterPermissionRestriction,omitempty"` - // CanChangeDomainUsersOnlyRestriction: Whether the current user can - // change the domainUsersOnly restriction of this shared drive. + // CanChangeDomainUsersOnlyRestriction: Output only. Whether the current + // user can change the `domainUsersOnly` restriction of this shared + // drive. CanChangeDomainUsersOnlyRestriction bool `json:"canChangeDomainUsersOnlyRestriction,omitempty"` - // CanChangeDriveBackground: Whether the current user can change the - // background of this shared drive. + // CanChangeDriveBackground: Output only. Whether the current user can + // change the background of this shared drive. CanChangeDriveBackground bool `json:"canChangeDriveBackground,omitempty"` - // CanChangeDriveMembersOnlyRestriction: Whether the current user can - // change the driveMembersOnly restriction of this shared drive. + // CanChangeDriveMembersOnlyRestriction: Output only. Whether the + // current user can change the `driveMembersOnly` restriction of this + // shared drive. CanChangeDriveMembersOnlyRestriction bool `json:"canChangeDriveMembersOnlyRestriction,omitempty"` - // CanChangeSharingFoldersRequiresOrganizerPermissionRestriction: - // Whether the current user can change the - // sharingFoldersRequiresOrganizerPermission restriction of this shared - // drive. + // CanChangeSharingFoldersRequiresOrganizerPermissionRestriction: Output + // only. Whether the current user can change the + // `sharingFoldersRequiresOrganizerPermission` restriction of this + // shared drive. CanChangeSharingFoldersRequiresOrganizerPermissionRestriction bool `json:"canChangeSharingFoldersRequiresOrganizerPermissionRestriction,omitempty"` - // CanComment: Whether the current user can comment on files in this - // shared drive. + // CanComment: Output only. Whether the current user can comment on + // files in this shared drive. CanComment bool `json:"canComment,omitempty"` - // CanCopy: Whether the current user can copy files in this shared - // drive. + // CanCopy: Output only. Whether the current user can copy files in this + // shared drive. CanCopy bool `json:"canCopy,omitempty"` - // CanDeleteChildren: Whether the current user can delete children from - // folders in this shared drive. + // CanDeleteChildren: Output only. Whether the current user can delete + // children from folders in this shared drive. CanDeleteChildren bool `json:"canDeleteChildren,omitempty"` - // CanDeleteDrive: 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. + // CanDeleteDrive: 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. CanDeleteDrive bool `json:"canDeleteDrive,omitempty"` - // CanDownload: Whether the current user can download files in this - // shared drive. + // CanDownload: Output only. Whether the current user can download files + // in this shared drive. CanDownload bool `json:"canDownload,omitempty"` - // CanEdit: Whether the current user can edit files in this shared drive + // CanEdit: Output only. Whether the current user can edit files in this + // shared drive CanEdit bool `json:"canEdit,omitempty"` - // CanListChildren: Whether the current user can list the children of - // folders in this shared drive. + // CanListChildren: Output only. Whether the current user can list the + // children of folders in this shared drive. CanListChildren bool `json:"canListChildren,omitempty"` - // CanManageMembers: Whether the current user can add members to this - // shared drive or remove them or change their role. + // CanManageMembers: Output only. Whether the current user can add + // members to this shared drive or remove them or change their role. CanManageMembers bool `json:"canManageMembers,omitempty"` - // CanReadRevisions: Whether the current user can read the revisions - // resource of files in this shared drive. + // CanReadRevisions: Output only. Whether the current user can read the + // revisions resource of files in this shared drive. CanReadRevisions bool `json:"canReadRevisions,omitempty"` - // CanRename: Whether the current user can rename files or folders in - // this shared drive. + // CanRename: Output only. Whether the current user can rename files or + // folders in this shared drive. CanRename bool `json:"canRename,omitempty"` - // CanRenameDrive: Whether the current user can rename this shared - // drive. + // CanRenameDrive: Output only. Whether the current user can rename this + // shared drive. CanRenameDrive bool `json:"canRenameDrive,omitempty"` - // CanResetDriveRestrictions: Whether the current user can reset the - // shared drive restrictions to defaults. + // CanResetDriveRestrictions: Output only. Whether the current user can + // reset the shared drive restrictions to defaults. CanResetDriveRestrictions bool `json:"canResetDriveRestrictions,omitempty"` - // CanShare: Whether the current user can share files or folders in this - // shared drive. + // CanShare: Output only. Whether the current user can share files or + // folders in this shared drive. CanShare bool `json:"canShare,omitempty"` - // CanTrashChildren: Whether the current user can trash children from - // folders in this shared drive. + // CanTrashChildren: Output only. Whether the current user can trash + // children from folders in this shared drive. CanTrashChildren bool `json:"canTrashChildren,omitempty"` // ForceSendFields is a list of field names (e.g. "CanAddChildren") to @@ -1127,9 +1133,9 @@ type DriveRestrictions struct { // CopyRequiresWriterPermission: 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. + // 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. CopyRequiresWriterPermission bool `json:"copyRequiresWriterPermission,omitempty"` // DomainUsersOnly: Whether access to this shared drive and items inside @@ -1218,17 +1224,18 @@ func (s *DriveList) MarshalJSON() ([]byte, error) { // File: The metadata for a file. type File struct { - // AppProperties: A collection of arbitrary key-value pairs that are + // AppProperties: A collection of arbitrary key-value pairs which are // private to the requesting app. // Entries 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 - // an OAuth 2 client ID. You cannot use an API key to retrieve private + // a OAuth 2 client ID. You cannot use an API key to retrieve private // properties. AppProperties map[string]string `json:"appProperties,omitempty"` - // Capabilities: Capabilities the current user has on this file. Each - // capability corresponds to a fine-grained action that a user can take. + // Capabilities: Output only. Capabilities the current user has on this + // file. Each capability corresponds to a fine-grained action that a + // user may take. Capabilities *FileCapabilities `json:"capabilities,omitempty"` // ContentHints: Additional information about the content of the file. @@ -1250,256 +1257,258 @@ type File struct { // Description: A short description of the file. Description string `json:"description,omitempty"` - // DriveId: ID of the shared drive the file resides in. Only populated - // for items in shared drives. + // DriveId: Output only. ID of the shared drive the file resides in. + // Only populated for items in shared drives. DriveId string `json:"driveId,omitempty"` - // ExplicitlyTrashed: Whether the file has been explicitly trashed, as - // opposed to recursively trashed from a parent folder. + // ExplicitlyTrashed: Output only. Whether the file has been explicitly + // trashed, as opposed to recursively trashed from a parent folder. ExplicitlyTrashed bool `json:"explicitlyTrashed,omitempty"` - // ExportLinks: Links for exporting Docs Editors files to specific - // formats. + // ExportLinks: Output only. Links for exporting Docs Editors files to + // specific formats. ExportLinks map[string]string `json:"exportLinks,omitempty"` - // FileExtension: The final component of fullFileExtension. This is only - // available for files with binary content in Google Drive. + // FileExtension: Output only. The final component of + // `fullFileExtension`. This is only available for files with binary + // content in Google Drive. FileExtension string `json:"fileExtension,omitempty"` - // FolderColorRgb: The color for a folder or shortcut to a folder as an - // RGB hex string. The supported colors are published in the - // folderColorPalette field of the About resource. - // If an unsupported color is specified, the closest color in the - // palette will be used instead. + // FolderColorRgb: 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 resource. If an unsupported + // color is specified, the closest color in the palette is used instead. FolderColorRgb string `json:"folderColorRgb,omitempty"` - // FullFileExtension: The full file extension extracted from the name - // field. Can 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 does not contain a valid extension. + // FullFileExtension: 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 is not cleared if the new name does + // not contain a valid extension. FullFileExtension string `json:"fullFileExtension,omitempty"` - // HasAugmentedPermissions: Whether there are permissions directly on - // this file. This field is only populated for items in shared drives. + // HasAugmentedPermissions: Output only. Whether there are permissions + // directly on this file. This field is only populated for items in + // shared drives. HasAugmentedPermissions bool `json:"hasAugmentedPermissions,omitempty"` - // HasThumbnail: Whether this file has a thumbnail. This does not - // indicate whether the requesting app has access to the thumbnail. To - // check access, look for the presence of the thumbnailLink field. + // HasThumbnail: Output only. Whether this file has a thumbnail. This + // does not indicate whether the requesting app has access to the + // thumbnail. To check access, look for the presence of the + // thumbnailLink field. HasThumbnail bool `json:"hasThumbnail,omitempty"` - // HeadRevisionId: The ID of the file's head revision. This is only - // available for files with binary content in Google Drive. + // HeadRevisionId: Output only. The ID of the file's head revision. This + // is currently only available for files with binary content in Google + // Drive. HeadRevisionId string `json:"headRevisionId,omitempty"` - // IconLink: A static, unauthenticated link to the file's icon. + // IconLink: Output only. A static, unauthenticated link to the file's + // icon. IconLink string `json:"iconLink,omitempty"` // Id: The ID of the file. Id string `json:"id,omitempty"` - // ImageMediaMetadata: Additional metadata about image media, if - // available. + // ImageMediaMetadata: Output only. Additional metadata about image + // media, if available. ImageMediaMetadata *FileImageMediaMetadata `json:"imageMediaMetadata,omitempty"` - // IsAppAuthorized: Whether the requesting app created or opened the - // file. + // IsAppAuthorized: Output only. Whether the file was created or opened + // by the requesting app. IsAppAuthorized bool `json:"isAppAuthorized,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#file". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#file". Kind string `json:"kind,omitempty"` - // LabelInfo: An overview of the labels on the file. + // LabelInfo: Output only. An overview of the labels on the file. LabelInfo *FileLabelInfo `json:"labelInfo,omitempty"` - // LastModifyingUser: The last user to modify the file. + // LastModifyingUser: Output only. The last user to modify the file. LastModifyingUser *User `json:"lastModifyingUser,omitempty"` // LinkShareMetadata: Contains details about the link URLs that clients // are using to refer to this item. LinkShareMetadata *FileLinkShareMetadata `json:"linkShareMetadata,omitempty"` - // Md5Checksum: The MD5 checksum for the content of the file. This is - // only applicable to files with binary content in Google Drive. + // Md5Checksum: Output only. The MD5 checksum for the content of the + // file. This is only applicable to files with binary content in Google + // Drive. Md5Checksum string `json:"md5Checksum,omitempty"` - // MimeType: The MIME type of the file. - // Google Drive will attempt 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 will be imported if possible. The supported import formats - // are published in the About resource. + // MimeType: 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 resource. MimeType string `json:"mimeType,omitempty"` - // ModifiedByMe: Whether this user has modified the file. + // ModifiedByMe: Output only. Whether the file has been modified by this + // user. ModifiedByMe bool `json:"modifiedByMe,omitempty"` - // ModifiedByMeTime: The last time the user modified the file (RFC 3339 - // date-time). + // ModifiedByMeTime: The last time the file was modified by the user + // (RFC 3339 date-time). ModifiedByMeTime string `json:"modifiedByMeTime,omitempty"` - // ModifiedTime: The last time anyone modified the file (RFC 3339 - // date-time). - // Note that setting modifiedTime will also update modifiedByMeTime for - // the user. + // ModifiedTime: he last time the file was modified by anyone (RFC 3339 + // date-time). Note that setting modifiedTime will also update + // modifiedByMeTime for the user. ModifiedTime string `json:"modifiedTime,omitempty"` - // Name: The name of the file. This isn't necessarily unique within a - // folder. Note that for immutable items such as the top-level folders + // Name: The name of the file. This is not necessarily unique within a + // folder. Note that for immutable items such as the top level folders // of shared drives, My Drive root folder, and Application Data folder // the name is constant. Name string `json:"name,omitempty"` // OriginalFilename: 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. + // available, or else the original value of the `name` field. This is + // only available for files with binary content in Google Drive. OriginalFilename string `json:"originalFilename,omitempty"` - // OwnedByMe: Whether the user owns the file. Not populated for items in - // shared drives. + // OwnedByMe: Output only. Whether the user owns the file. Not populated + // for items in shared drives. OwnedByMe bool `json:"ownedByMe,omitempty"` - // Owners: The owner of this file. Only certain legacy files might have - // more than one owner. This field isn't populated for items in shared - // drives. + // Owners: 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. Owners []*User `json:"owners,omitempty"` - // Parents: The IDs of the parent folders that contain the file. - // If not specified as part of a create request, the file will be placed - // directly in the user's My Drive folder. If not specified as part of a - // copy request, the file will inherit any discoverable parents of the - // source file. Update requests must use the addParents and - // removeParents parameters to modify the parents list. + // Parents: The IDs of the parent folders which contain the file. 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 parents of the source + // file. Update requests must use the `addParents` and `removeParents` + // parameters to modify the parents list. Parents []string `json:"parents,omitempty"` - // PermissionIds: List of permission IDs for users with access to this - // file. + // PermissionIds: Output only. List of permission IDs for users with + // access to this file. PermissionIds []string `json:"permissionIds,omitempty"` - // Permissions: 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. + // Permissions: 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. Permissions []*Permission `json:"permissions,omitempty"` - // Properties: A collection of arbitrary key-value pairs that are + // Properties: A collection of arbitrary key-value pairs which are // visible to all apps. // Entries with null values are cleared in update and copy requests. Properties map[string]string `json:"properties,omitempty"` - // QuotaBytesUsed: The number of storage quota bytes used by the file. - // This includes the head revision as well as previous revisions with - // keepForever enabled. + // QuotaBytesUsed: 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. QuotaBytesUsed int64 `json:"quotaBytesUsed,omitempty,string"` - // ResourceKey: A key needed to access the item via a shared link. + // ResourceKey: Output only. A key needed to access the item via a + // shared link. ResourceKey string `json:"resourceKey,omitempty"` - // Sha1Checksum: 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. + // Sha1Checksum: 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 is not populated for Docs Editors + // or shortcut files. Sha1Checksum string `json:"sha1Checksum,omitempty"` - // Sha256Checksum: 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. + // Sha256Checksum: 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 is not populated for Docs Editors + // or shortcut files. Sha256Checksum string `json:"sha256Checksum,omitempty"` - // Shared: Whether the file has been shared. Not populated for items in - // shared drives. + // Shared: Output only. Whether the file has been shared. Not populated + // for items in shared drives. Shared bool `json:"shared,omitempty"` // SharedWithMeTime: The time at which the file was shared with the // user, if applicable (RFC 3339 date-time). SharedWithMeTime string `json:"sharedWithMeTime,omitempty"` - // SharingUser: The user who shared the file with the requesting user, - // if applicable. + // SharingUser: Output only. The user who shared the file with the + // requesting user, if applicable. SharingUser *User `json:"sharingUser,omitempty"` // ShortcutDetails: Shortcut file details. Only populated for shortcut // files, which have the mimeType field set to - // application/vnd.google-apps.shortcut. + // `application/vnd.google-apps.shortcut`. ShortcutDetails *FileShortcutDetails `json:"shortcutDetails,omitempty"` - // Size: The size of the file's content in bytes. This field is - // populated for files with binary content stored in Google Drive and - // for Docs Editors files; it's not populated for shortcuts or folders. + // Size: Output only. Size in bytes of blobs and first party editor + // files. Won't be populated for files that have no size, like shortcuts + // and folders. Size int64 `json:"size,omitempty,string"` - // Spaces: The list of spaces that contain the file. The currently - // supported values are 'drive', 'appDataFolder' and 'photos'. + // Spaces: Output only. The list of spaces which contain the file. The + // currently supported values are 'drive', 'appDataFolder' and 'photos'. Spaces []string `json:"spaces,omitempty"` // Starred: Whether the user has starred the file. Starred bool `json:"starred,omitempty"` - // TeamDriveId: Deprecated - use driveId instead. + // TeamDriveId: Deprecated: Output only. Use `driveId` instead. TeamDriveId string `json:"teamDriveId,omitempty"` - // ThumbnailLink: A short-lived link to the file's thumbnail, if - // available. Typically lasts on the order of hours. 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. + // ThumbnailLink: Output only. A short-lived link to the file's + // thumbnail, if available. Typically lasts on the order of hours. Only + // populated when the requesting app can access the file's content. ThumbnailLink string `json:"thumbnailLink,omitempty"` - // ThumbnailVersion: The thumbnail version for use in thumbnail cache - // invalidation. + // ThumbnailVersion: Output only. The thumbnail version for use in + // thumbnail cache invalidation. ThumbnailVersion int64 `json:"thumbnailVersion,omitempty,string"` // Trashed: Whether the file has been trashed, either explicitly or from - // a trashed parent folder. Only the owner can trash a file. The trashed - // item is excluded from all files.list responses returned for any user - // who does not own the file. However, all users with access to the file - // can see the trashed item metadata in an API response. All users with - // access can copy, download, export, and share the file. + // a trashed parent folder. Only the owner may trash a file, and other + // users cannot see files in the owner's trash. Trashed bool `json:"trashed,omitempty"` // TrashedTime: The time that the item was trashed (RFC 3339 date-time). // Only populated for items in shared drives. TrashedTime string `json:"trashedTime,omitempty"` - // TrashingUser: If the file has been explicitly trashed, the user who - // trashed it. Only populated for items in shared drives. + // TrashingUser: Output only. If the file has been explicitly trashed, + // the user who trashed it. Only populated for items in shared drives. TrashingUser *User `json:"trashingUser,omitempty"` - // Version: 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. + // Version: 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. Version int64 `json:"version,omitempty,string"` - // VideoMediaMetadata: Additional metadata about video media. This might - // not be available immediately upon upload. + // VideoMediaMetadata: Output only. Additional metadata about video + // media. This may not be available immediately upon upload. VideoMediaMetadata *FileVideoMediaMetadata `json:"videoMediaMetadata,omitempty"` - // ViewedByMe: Whether this user has viewed the file. + // ViewedByMe: Output only. Whether the file has been viewed by this + // user. ViewedByMe bool `json:"viewedByMe,omitempty"` - // ViewedByMeTime: The last time the user viewed the file (RFC 3339 - // date-time). + // ViewedByMeTime: The last time the file was viewed by the user (RFC + // 3339 date-time). ViewedByMeTime string `json:"viewedByMeTime,omitempty"` - // ViewersCanCopyContent: Deprecated - use copyRequiresWriterPermission + // ViewersCanCopyContent: Deprecated: Use `copyRequiresWriterPermission` // instead. ViewersCanCopyContent bool `json:"viewersCanCopyContent,omitempty"` - // WebContentLink: A link for downloading the content of the file in a - // browser. This is only available for files with binary content in - // Google Drive. + // WebContentLink: 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. WebContentLink string `json:"webContentLink,omitempty"` - // WebViewLink: A link for opening the file in a relevant Google editor - // or viewer in a browser. + // WebViewLink: Output only. A link for opening the file in a relevant + // Google editor or viewer in a browser. WebViewLink string `json:"webViewLink,omitempty"` - // WritersCanShare: Whether users with only writer permission can modify - // the file's permissions. Not populated for items in shared drives. + // WritersCanShare: Whether users with only `writer` permission can + // modify the file's permissions. Not populated for items in shared + // drives. WritersCanShare bool `json:"writersCanShare,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1529,174 +1538,186 @@ func (s *File) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// FileCapabilities: Capabilities the current user has on this file. -// Each capability corresponds to a fine-grained action that a user can -// take. +// FileCapabilities: Output only. Capabilities the current user has on +// this file. Each capability corresponds to a fine-grained action that +// a user may take. type FileCapabilities struct { - // CanAcceptOwnership: Whether the current user is the pending owner of - // the file. Not populated for shared drive files. + // CanAcceptOwnership: Output only. Whether the current user is the + // pending owner of the file. Not populated for shared drive files. CanAcceptOwnership bool `json:"canAcceptOwnership,omitempty"` - // CanAddChildren: Whether the current user can add children to this - // folder. This is always false when the item isn't a folder. + // CanAddChildren: Output only. Whether the current user can add + // children to this folder. This is always false when the item is not a + // folder. CanAddChildren bool `json:"canAddChildren,omitempty"` - // CanAddFolderFromAnotherDrive: 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. + // CanAddFolderFromAnotherDrive: 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 is not a folder. + // Only populated for items in shared drives. CanAddFolderFromAnotherDrive bool `json:"canAddFolderFromAnotherDrive,omitempty"` - // CanAddMyDriveParent: 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. + // CanAddMyDriveParent: 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. CanAddMyDriveParent bool `json:"canAddMyDriveParent,omitempty"` - // CanChangeCopyRequiresWriterPermission: Whether the current user can - // change the copyRequiresWriterPermission restriction of this file. + // CanChangeCopyRequiresWriterPermission: Output only. Whether the + // current user can change the `copyRequiresWriterPermission` + // restriction of this file. CanChangeCopyRequiresWriterPermission bool `json:"canChangeCopyRequiresWriterPermission,omitempty"` - // CanChangeSecurityUpdateEnabled: Whether the current user can change - // the securityUpdateEnabled field on link share metadata. + // CanChangeSecurityUpdateEnabled: Output only. Whether the current user + // can change the securityUpdateEnabled field on link share metadata. CanChangeSecurityUpdateEnabled bool `json:"canChangeSecurityUpdateEnabled,omitempty"` - // CanChangeViewersCanCopyContent: Deprecated + // CanChangeViewersCanCopyContent: Deprecated: Output only. CanChangeViewersCanCopyContent bool `json:"canChangeViewersCanCopyContent,omitempty"` - // CanComment: Whether the current user can comment on this file. + // CanComment: Output only. Whether the current user can comment on this + // file. CanComment bool `json:"canComment,omitempty"` - // CanCopy: 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 itself if it's not a folder. + // CanCopy: 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 itself if it is not + // a folder. CanCopy bool `json:"canCopy,omitempty"` - // CanDelete: Whether the current user can delete this file. + // CanDelete: Output only. Whether the current user can delete this + // file. CanDelete bool `json:"canDelete,omitempty"` - // CanDeleteChildren: 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. + // CanDeleteChildren: Output only. Whether the current user can delete + // children of this folder. This is false when the item is not a folder. + // Only populated for items in shared drives. CanDeleteChildren bool `json:"canDeleteChildren,omitempty"` - // CanDownload: Whether the current user can download this file. + // CanDownload: Output only. Whether the current user can download this + // file. CanDownload bool `json:"canDownload,omitempty"` - // CanEdit: Whether the current user can edit this file. Other factors - // might limit the type of changes a user can make to a file. For - // example, see canChangeCopyRequiresWriterPermission or - // canModifyContent. + // CanEdit: 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`. CanEdit bool `json:"canEdit,omitempty"` - // CanListChildren: Whether the current user can list the children of - // this folder. This is always false when the item isn't a folder. + // CanListChildren: Output only. Whether the current user can list the + // children of this folder. This is always false when the item is not a + // folder. CanListChildren bool `json:"canListChildren,omitempty"` - // CanModifyContent: Whether the current user can modify the content of - // this file. + // CanModifyContent: Output only. Whether the current user can modify + // the content of this file. CanModifyContent bool `json:"canModifyContent,omitempty"` - // CanModifyContentRestriction: Whether the current user can modify - // restrictions on content of this file. + // CanModifyContentRestriction: Output only. Whether the current user + // can modify restrictions on content of this file. CanModifyContentRestriction bool `json:"canModifyContentRestriction,omitempty"` - // CanModifyLabels: Whether the current user can modify the labels on - // this file. + // CanModifyLabels: Output only. Whether the current user can modify the + // labels on the file. CanModifyLabels bool `json:"canModifyLabels,omitempty"` - // CanMoveChildrenOutOfDrive: 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. + // CanMoveChildrenOutOfDrive: Output only. Whether the current user can + // move children of this folder outside of the shared drive. This is + // false when the item is not a folder. Only populated for items in + // shared drives. CanMoveChildrenOutOfDrive bool `json:"canMoveChildrenOutOfDrive,omitempty"` - // CanMoveChildrenOutOfTeamDrive: Deprecated - use - // canMoveChildrenOutOfDrive instead. + // CanMoveChildrenOutOfTeamDrive: Deprecated: Output only. Use + // `canMoveChildrenOutOfDrive` instead. CanMoveChildrenOutOfTeamDrive bool `json:"canMoveChildrenOutOfTeamDrive,omitempty"` - // CanMoveChildrenWithinDrive: Whether the current user can move - // children of this folder within this shared drive or My Drive. This is - // false when the item isn't a folder. Note that a request to move the - // child might still fail depending on the current user's access to the - // child and to the destination folder. + // CanMoveChildrenWithinDrive: Output only. Whether the current user can + // move children of this folder within this drive. This is false when + // the item is not 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. CanMoveChildrenWithinDrive bool `json:"canMoveChildrenWithinDrive,omitempty"` - // CanMoveChildrenWithinTeamDrive: Deprecated - use - // canMoveChildrenWithinDrive instead. + // CanMoveChildrenWithinTeamDrive: Deprecated: Output only. Use + // `canMoveChildrenWithinDrive` instead. CanMoveChildrenWithinTeamDrive bool `json:"canMoveChildrenWithinTeamDrive,omitempty"` - // CanMoveItemIntoTeamDrive: Deprecated - use canMoveItemOutOfDrive - // instead. + // CanMoveItemIntoTeamDrive: Deprecated: Output only. Use + // `canMoveItemOutOfDrive` instead. CanMoveItemIntoTeamDrive bool `json:"canMoveItemIntoTeamDrive,omitempty"` - // CanMoveItemOutOfDrive: Whether the current user can move this item - // outside of this shared drive or My Drive by changing its parent. Note - // that a request to change the parent of the item might still fail - // depending on the new parent that's being added. + // CanMoveItemOutOfDrive: 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 is being added. CanMoveItemOutOfDrive bool `json:"canMoveItemOutOfDrive,omitempty"` - // CanMoveItemOutOfTeamDrive: Deprecated - use canMoveItemOutOfDrive - // instead. + // CanMoveItemOutOfTeamDrive: Deprecated: Output only. Use + // `canMoveItemOutOfDrive` instead. CanMoveItemOutOfTeamDrive bool `json:"canMoveItemOutOfTeamDrive,omitempty"` - // CanMoveItemWithinDrive: Whether the current user can move this item - // within this shared drive or My Drive. Note that a request to change - // the parent of the item might still fail depending on the new parent - // that's being added and the parent that's being removed. + // CanMoveItemWithinDrive: 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 is + // being added and the parent that is being removed. CanMoveItemWithinDrive bool `json:"canMoveItemWithinDrive,omitempty"` - // CanMoveItemWithinTeamDrive: Deprecated - use canMoveItemWithinDrive - // instead. + // CanMoveItemWithinTeamDrive: Deprecated: Output only. Use + // `canMoveItemWithinDrive` instead. CanMoveItemWithinTeamDrive bool `json:"canMoveItemWithinTeamDrive,omitempty"` - // CanMoveTeamDriveItem: Deprecated - use canMoveItemWithinDrive or - // canMoveItemOutOfDrive instead. + // CanMoveTeamDriveItem: Deprecated: Output only. Use + // `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. CanMoveTeamDriveItem bool `json:"canMoveTeamDriveItem,omitempty"` - // CanReadDrive: Whether the current user can read the shared drive to - // which this file belongs. Only populated for items in shared drives. + // CanReadDrive: Output only. Whether the current user can read the + // shared drive to which this file belongs. Only populated for items in + // shared drives. CanReadDrive bool `json:"canReadDrive,omitempty"` - // CanReadLabels: Whether the current user can read the labels on this - // file. + // CanReadLabels: Output only. Whether the current user can read the + // labels on the file. CanReadLabels bool `json:"canReadLabels,omitempty"` - // CanReadRevisions: 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 itself if it's not - // a folder, can be read. + // CanReadRevisions: 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 itself + // if it is not a folder, can be read. CanReadRevisions bool `json:"canReadRevisions,omitempty"` - // CanReadTeamDrive: Deprecated - use canReadDrive instead. + // CanReadTeamDrive: Deprecated: Output only. Use `canReadDrive` + // instead. CanReadTeamDrive bool `json:"canReadTeamDrive,omitempty"` - // CanRemoveChildren: 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. + // CanRemoveChildren: Output only. Whether the current user can remove + // children from this folder. This is always false when the item is not + // a folder. For a folder in a shared drive, use `canDeleteChildren` or + // `canTrashChildren` instead. CanRemoveChildren bool `json:"canRemoveChildren,omitempty"` - // CanRemoveMyDriveParent: 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. + // CanRemoveMyDriveParent: 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. CanRemoveMyDriveParent bool `json:"canRemoveMyDriveParent,omitempty"` - // CanRename: Whether the current user can rename this file. + // CanRename: Output only. Whether the current user can rename this + // file. CanRename bool `json:"canRename,omitempty"` - // CanShare: Whether the current user can modify the sharing settings - // for this file. + // CanShare: Output only. Whether the current user can modify the + // sharing settings for this file. CanShare bool `json:"canShare,omitempty"` - // CanTrash: Whether the current user can move this file to trash. + // CanTrash: Output only. Whether the current user can move this file to + // trash. CanTrash bool `json:"canTrash,omitempty"` - // CanTrashChildren: 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. + // CanTrashChildren: Output only. Whether the current user can trash + // children of this folder. This is false when the item is not a folder. + // Only populated for items in shared drives. CanTrashChildren bool `json:"canTrashChildren,omitempty"` - // CanUntrash: Whether the current user can restore this file from - // trash. + // CanUntrash: Output only. Whether the current user can restore this + // file from trash. CanUntrash bool `json:"canUntrash,omitempty"` // ForceSendFields is a list of field names (e.g. "CanAcceptOwnership") @@ -1727,8 +1748,8 @@ func (s *FileCapabilities) MarshalJSON() ([]byte, error) { // file. These fields are never populated in responses. type FileContentHints struct { // IndexableText: Text to be indexed for the file to improve fullText - // queries. This is limited to 128 KB in length and might contain HTML - // elements. For more information, see Manage file metadata. + // queries. This is limited to 128KB in length and may contain HTML + // elements. IndexableText string `json:"indexableText,omitempty"` // Thumbnail: A thumbnail for the file. This will only be used if Google @@ -1791,73 +1812,83 @@ func (s *FileContentHintsThumbnail) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// FileImageMediaMetadata: Additional metadata about image media, if -// available. +// FileImageMediaMetadata: Output only. Additional metadata about image +// media, if available. type FileImageMediaMetadata struct { - // Aperture: The aperture used to create the photo (f-number). + // Aperture: Output only. The aperture used to create the photo + // (f-number). Aperture float64 `json:"aperture,omitempty"` - // CameraMake: The make of the camera used to create the photo. + // CameraMake: Output only. The make of the camera used to create the + // photo. CameraMake string `json:"cameraMake,omitempty"` - // CameraModel: The model of the camera used to create the photo. + // CameraModel: Output only. The model of the camera used to create the + // photo. CameraModel string `json:"cameraModel,omitempty"` - // ColorSpace: The color space of the photo. + // ColorSpace: Output only. The color space of the photo. ColorSpace string `json:"colorSpace,omitempty"` - // ExposureBias: The exposure bias of the photo (APEX value). + // ExposureBias: Output only. The exposure bias of the photo (APEX + // value). ExposureBias float64 `json:"exposureBias,omitempty"` - // ExposureMode: The exposure mode used to create the photo. + // ExposureMode: Output only. The exposure mode used to create the + // photo. ExposureMode string `json:"exposureMode,omitempty"` - // ExposureTime: The length of the exposure, in seconds. + // ExposureTime: Output only. The length of the exposure, in seconds. ExposureTime float64 `json:"exposureTime,omitempty"` - // FlashUsed: Whether a flash was used to create the photo. + // FlashUsed: Output only. Whether a flash was used to create the photo. FlashUsed bool `json:"flashUsed,omitempty"` - // FocalLength: The focal length used to create the photo, in - // millimeters. + // FocalLength: Output only. The focal length used to create the photo, + // in millimeters. FocalLength float64 `json:"focalLength,omitempty"` - // Height: The height of the image in pixels. + // Height: Output only. The height of the image in pixels. Height int64 `json:"height,omitempty"` - // IsoSpeed: The ISO speed used to create the photo. + // IsoSpeed: Output only. The ISO speed used to create the photo. IsoSpeed int64 `json:"isoSpeed,omitempty"` - // Lens: The lens used to create the photo. + // Lens: Output only. The lens used to create the photo. Lens string `json:"lens,omitempty"` - // Location: Geographic location information stored in the image. + // Location: Output only. Geographic location information stored in the + // image. Location *FileImageMediaMetadataLocation `json:"location,omitempty"` - // MaxApertureValue: The smallest f-number of the lens at the focal - // length used to create the photo (APEX value). + // MaxApertureValue: Output only. The smallest f-number of the lens at + // the focal length used to create the photo (APEX value). MaxApertureValue float64 `json:"maxApertureValue,omitempty"` - // MeteringMode: The metering mode used to create the photo. + // MeteringMode: Output only. The metering mode used to create the + // photo. MeteringMode string `json:"meteringMode,omitempty"` - // Rotation: The number of clockwise 90-degree rotations applied from - // the image's original orientation. + // Rotation: Output only. The number of clockwise 90 degree rotations + // applied from the image's original orientation. Rotation int64 `json:"rotation,omitempty"` - // Sensor: The type of sensor used to create the photo. + // Sensor: Output only. The type of sensor used to create the photo. Sensor string `json:"sensor,omitempty"` - // SubjectDistance: The distance to the subject of the photo, in meters. + // SubjectDistance: Output only. The distance to the subject of the + // photo, in meters. SubjectDistance int64 `json:"subjectDistance,omitempty"` - // Time: The date and time the photo was taken (EXIF DateTime). + // Time: Output only. The date and time the photo was taken (EXIF + // DateTime). Time string `json:"time,omitempty"` - // WhiteBalance: The white balance mode used to create the photo. + // WhiteBalance: Output only. The white balance mode used to create the + // photo. WhiteBalance string `json:"whiteBalance,omitempty"` - // Width: The width of the image in pixels. + // Width: Output only. The width of the image in pixels. Width int64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "Aperture") to @@ -1905,16 +1936,16 @@ func (s *FileImageMediaMetadata) UnmarshalJSON(data []byte) error { return nil } -// FileImageMediaMetadataLocation: Geographic location information -// stored in the image. +// FileImageMediaMetadataLocation: Output only. Geographic location +// information stored in the image. type FileImageMediaMetadataLocation struct { - // Altitude: The altitude stored in the image. + // Altitude: Output only. The altitude stored in the image. Altitude float64 `json:"altitude,omitempty"` - // Latitude: The latitude stored in the image. + // Latitude: Output only. The latitude stored in the image. Latitude float64 `json:"latitude,omitempty"` - // Longitude: The longitude stored in the image. + // Longitude: Output only. The longitude stored in the image. Longitude float64 `json:"longitude,omitempty"` // ForceSendFields is a list of field names (e.g. "Altitude") to @@ -1958,10 +1989,11 @@ func (s *FileImageMediaMetadataLocation) UnmarshalJSON(data []byte) error { return nil } -// FileLabelInfo: An overview of the labels on the file. +// FileLabelInfo: Output only. An overview of the labels on the file. type FileLabelInfo struct { - // Labels: The set of labels on the file as requested by the label IDs - // in the includeLabels parameter. By default, no labels are returned. + // Labels: 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. Labels []*Label `json:"labels,omitempty"` // ForceSendFields is a list of field names (e.g. "Labels") to @@ -1990,12 +2022,12 @@ func (s *FileLabelInfo) MarshalJSON() ([]byte, error) { // FileLinkShareMetadata: Contains details about the link URLs that // clients are using to refer to this item. type FileLinkShareMetadata struct { - // SecurityUpdateEligible: Whether the file is eligible for security - // update. + // SecurityUpdateEligible: Output only. Whether the file is eligible for + // security update. SecurityUpdateEligible bool `json:"securityUpdateEligible,omitempty"` - // SecurityUpdateEnabled: Whether the security update is enabled for - // this file. + // SecurityUpdateEnabled: Output only. Whether the security update is + // enabled for this file. SecurityUpdateEnabled bool `json:"securityUpdateEnabled,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -2025,17 +2057,17 @@ func (s *FileLinkShareMetadata) MarshalJSON() ([]byte, error) { // FileShortcutDetails: Shortcut file details. Only populated for // shortcut files, which have the mimeType field set to -// application/vnd.google-apps.shortcut. +// `application/vnd.google-apps.shortcut`. type FileShortcutDetails struct { // TargetId: The ID of the file that this shortcut points to. TargetId string `json:"targetId,omitempty"` - // TargetMimeType: 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. + // TargetMimeType: 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. TargetMimeType string `json:"targetMimeType,omitempty"` - // TargetResourceKey: The ResourceKey for the target file. + // TargetResourceKey: Output only. The ResourceKey for the target file. TargetResourceKey string `json:"targetResourceKey,omitempty"` // ForceSendFields is a list of field names (e.g. "TargetId") to @@ -2061,16 +2093,17 @@ func (s *FileShortcutDetails) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// FileVideoMediaMetadata: Additional metadata about video media. This -// might not be available immediately upon upload. +// FileVideoMediaMetadata: Output only. Additional metadata about video +// media. This may not be available immediately upon upload. type FileVideoMediaMetadata struct { - // DurationMillis: The duration of the video in milliseconds. + // DurationMillis: Output only. The duration of the video in + // milliseconds. DurationMillis int64 `json:"durationMillis,omitempty,string"` - // Height: The height of the video in pixels. + // Height: Output only. The height of the video in pixels. Height int64 `json:"height,omitempty"` - // Width: The width of the video in pixels. + // Width: Output only. The width of the video in pixels. Width int64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "DurationMillis") to @@ -2190,9 +2223,9 @@ func (s *GeneratedIds) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Label: Representation of a label and its fields. +// Label: Representation of label and label fields. type Label struct { - // Fields: A map of the label's fields keyed by the field ID. + // Fields: A map of the fields on the label, keyed by the field's ID. Fields map[string]LabelField `json:"fields,omitempty"` // Id: The ID of the label. @@ -2227,37 +2260,33 @@ func (s *Label) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// LabelField: Representation of a label field. +// LabelField: Representation of field, which is a typed key-value pair. type LabelField struct { // DateString: Only present if valueType is dateString. RFC 3339 // formatted date: YYYY-MM-DD. DateString []string `json:"dateString,omitempty"` - // Id: The identifier of this field. + // Id: The identifier of this label field. Id string `json:"id,omitempty"` - // Integer: Only present if valueType is integer. + // Integer: Only present if `valueType` is `integer`. Integer googleapi.Int64s `json:"integer,omitempty"` // Kind: This is always drive#labelField. Kind string `json:"kind,omitempty"` - // Selection: Only present if valueType is selection. + // Selection: Only present if `valueType` is `selection` Selection []string `json:"selection,omitempty"` - // Text: Only present if valueType is text. + // Text: Only present if `valueType` is `text`. Text []string `json:"text,omitempty"` - // User: Only present if valueType is user. + // User: Only present if `valueType` is `user`. User []*User `json:"user,omitempty"` // ValueType: The field type. While new values may be supported in the - // future, the following are currently allowed: - // - dateString - // - integer - // - selection - // - text - // - user + // future, the following are currently allowed: * `dateString` * + // `integer` * `selection` * `text` * `user` ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "DateString") to @@ -2285,26 +2314,29 @@ func (s *LabelField) MarshalJSON() ([]byte, error) { // LabelFieldModification: A modification to a label's field. type LabelFieldModification struct { - // FieldId: The ID of the Field to be modified. + // FieldId: The ID of the field to be modified. FieldId string `json:"fieldId,omitempty"` // Kind: This is always drive#labelFieldModification. Kind string `json:"kind,omitempty"` - // SetDateValues: Replaces a dateString field with these new values. The - // values must be strings in the RFC 3339 full-date format: YYYY-MM-DD. + // SetDateValues: 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. SetDateValues []string `json:"setDateValues,omitempty"` - // SetIntegerValues: Replaces an integer field with these new values. + // SetIntegerValues: Replaces the value of an `integer` field with these + // new values. SetIntegerValues googleapi.Int64s `json:"setIntegerValues,omitempty"` - // SetSelectionValues: Replaces a selection field with these new values. + // SetSelectionValues: Replaces a `selection` field with these new + // values. SetSelectionValues []string `json:"setSelectionValues,omitempty"` - // SetTextValues: Replaces a text field with these new values. + // SetTextValues: Sets the value of a `text` field. SetTextValues []string `json:"setTextValues,omitempty"` - // SetUserValues: Replaces a user field with these new values. The + // SetUserValues: Replaces a `user` field with these new values. The // values must be valid email addresses. SetUserValues []string `json:"setUserValues,omitempty"` @@ -2334,7 +2366,7 @@ func (s *LabelFieldModification) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// LabelList: A list of labels. +// LabelList: A list of labels applied to a file. type LabelList struct { // Kind: This is always drive#labelList Kind string `json:"kind,omitempty"` @@ -2417,9 +2449,9 @@ func (s *LabelModification) MarshalJSON() ([]byte, error) { // ModifyLabelsRequest: 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 transactionally. +// succeed or all fail atomically. type ModifyLabelsRequest struct { - // Kind: This is always drive#modifyLabelsRequest + // Kind: This is always drive#modifyLabelsRequest. Kind string `json:"kind,omitempty"` // LabelModifications: The list of modifications to apply to the labels @@ -2488,31 +2520,28 @@ func (s *ModifyLabelsResponse) MarshalJSON() ([]byte, error) { } // Permission: A permission for a file. A permission grants a user, -// group, domain, or the world access to a file or a folder hierarchy. +// group, domain or the world access to a file or a folder hierarchy. type Permission struct { // AllowFileDiscovery: Whether the permission allows the file to be // discovered through search. This is only applicable for permissions of - // type domain or anyone. + // type `domain` or `anyone`. AllowFileDiscovery bool `json:"allowFileDiscovery,omitempty"` - // Deleted: Whether the account associated with this permission has been - // deleted. This field only pertains to user and group permissions. + // Deleted: Output only. Whether the account associated with this + // permission has been deleted. This field only pertains to user and + // group permissions. Deleted bool `json:"deleted,omitempty"` - // DisplayName: 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 "Joe Smith." - // - group - Name of the Google Group, such as "The Company - // Administrators." - // - domain - String domain name, such as "your-company.com." - // - anyone - No displayName is present. + // DisplayName: 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 "Joe Smith." * `group` - Name of the Google Group, + // such as "The Company Administrators." * `domain` - String domain + // name, such as "thecompany.com." * `anyone` - No `displayName` is + // present. DisplayName string `json:"displayName,omitempty"` - // Domain: The domain to which this permission refers. The following - // options are currently allowed: - // - The entire domain, such as "your-company.com." - // - A target audience, such as "ID.audience.googledomains.com." + // Domain: The domain to which this permission refers. Domain string `json:"domain,omitempty"` // EmailAddress: The email address of the user or group to which this @@ -2520,62 +2549,53 @@ type Permission struct { EmailAddress string `json:"emailAddress,omitempty"` // ExpirationTime: The time at which this permission will expire (RFC - // 3339 date-time). Expiration times have the following restrictions: - // - // - They cannot be set on shared drive items. - // - They can only be set on user and group permissions. - // - The time must be in the future. - // - The time cannot be more than one year in the future. + // 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 ExpirationTime string `json:"expirationTime,omitempty"` - // Id: The ID of this permission. This is a unique identifier for the - // grantee, and is published in User resources as permissionId. IDs - // should be treated as opaque values. + // Id: Output only. The ID of this permission. This is a unique + // identifier for the grantee, and is published in User resources as + // `permissionId`. IDs should be treated as opaque values. Id string `json:"id,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#permission". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#permission". Kind string `json:"kind,omitempty"` // PendingOwner: Whether the account associated with this permission is - // a pending owner. Only populated for user type permissions for files - // that aren't in a shared drive. + // a pending owner. Only populated for `user` type permissions for files + // that are not in a shared drive. PendingOwner bool `json:"pendingOwner,omitempty"` - // PermissionDetails: Details of whether the permissions on this shared - // drive item are inherited or are directly on this item. This is an - // output-only field that's present only for shared drive items. + // PermissionDetails: Output only. Details of whether the permissions on + // this shared drive item are inherited or directly on this item. This + // is an output-only field which is present only for shared drive items. PermissionDetails []*PermissionPermissionDetails `json:"permissionDetails,omitempty"` - // PhotoLink: A link to the user's profile photo, if available. + // PhotoLink: Output only. A link to the user's profile photo, if + // available. PhotoLink string `json:"photoLink,omitempty"` // Role: The role granted by this permission. While new values may be - // supported in the future, the following are currently allowed: - // - owner - // - organizer - // - fileOrganizer - // - writer - // - commenter - // - reader + // supported in the future, the following are currently allowed: * + // `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * + // `reader` Role string `json:"role,omitempty"` - // TeamDrivePermissionDetails: Deprecated - use permissionDetails - // instead. + // TeamDrivePermissionDetails: Output only. Deprecated: Output only. Use + // `permissionDetails` instead. TeamDrivePermissionDetails []*PermissionTeamDrivePermissionDetails `json:"teamDrivePermissionDetails,omitempty"` - // Type: The type of the grantee. Valid values are: - // - user - // - group - // - domain - // - anyone When creating a permission, if type is user or group, you - // must provide an emailAddress for the user or group. When type is - // domain, you must provide a domain. There isn't extra information - // required for the anyone type. + // Type: The type of the grantee. Valid values are: * `user` * `group` * + // `domain` * `anyone` When creating a permission, if `type` is `user` + // or `group`, you must provide an `emailAddress` for the user or group. + // When `type` is `domain`, you must provide a `domain`. There isn't + // extra information required for an `anyone` type. Type string `json:"type,omitempty"` // View: Indicates the view for this permission. Only populated for - // permissions that belong to a view. published is the only supported + // permissions that belong to a view. 'published' is the only supported // value. View string `json:"view,omitempty"` @@ -2608,27 +2628,22 @@ func (s *Permission) MarshalJSON() ([]byte, error) { } type PermissionPermissionDetails struct { - // Inherited: Whether this permission is inherited. This field is always - // populated. This is an output-only field. + // Inherited: Output only. Whether this permission is inherited. This + // field is always populated. This is an output-only field. Inherited bool `json:"inherited,omitempty"` - // InheritedFrom: The ID of the item from which this permission is - // inherited. This is an output-only field. + // InheritedFrom: Output only. The ID of the item from which this + // permission is inherited. This is an output-only field. InheritedFrom string `json:"inheritedFrom,omitempty"` - // PermissionType: The permission type for this user. While new values - // may be added in future, the following are currently allowed: - // - file - // - member + // PermissionType: Output only. The permission type for this user. While + // new values may be added in future, the following are currently + // possible: * `file` * `member` PermissionType string `json:"permissionType,omitempty"` - // Role: The primary role for this user. While new values may be added - // in the future, the following are currently allowed: - // - organizer - // - fileOrganizer - // - writer - // - commenter - // - reader + // Role: Output only. The primary role for this user. While new values + // may be added in the future, the following are currently possible: * + // `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` Role string `json:"role,omitempty"` // ForceSendFields is a list of field names (e.g. "Inherited") to @@ -2655,18 +2670,19 @@ func (s *PermissionPermissionDetails) MarshalJSON() ([]byte, error) { } type PermissionTeamDrivePermissionDetails struct { - // Inherited: Deprecated - use permissionDetails/inherited instead. + // Inherited: Deprecated: Output only. Use `permissionDetails/inherited` + // instead. Inherited bool `json:"inherited,omitempty"` - // InheritedFrom: Deprecated - use permissionDetails/inheritedFrom - // instead. + // InheritedFrom: Deprecated: Output only. Use + // `permissionDetails/inheritedFrom` instead. InheritedFrom string `json:"inheritedFrom,omitempty"` - // Role: Deprecated - use permissionDetails/role instead. + // Role: Deprecated: Output only. Use `permissionDetails/role` instead. Role string `json:"role,omitempty"` - // TeamDrivePermissionType: Deprecated - use - // permissionDetails/permissionType instead. + // TeamDrivePermissionType: Deprecated: Output only. Use + // `permissionDetails/permissionType` instead. TeamDrivePermissionType string `json:"teamDrivePermissionType,omitempty"` // ForceSendFields is a list of field names (e.g. "Inherited") to @@ -2740,36 +2756,35 @@ func (s *PermissionList) MarshalJSON() ([]byte, error) { // Reply: A reply to a comment on a file. type Reply struct { // Action: The action the reply performed to the parent comment. Valid - // values are: - // - resolve - // - reopen + // values are: * `resolve` * `reopen` Action string `json:"action,omitempty"` - // Author: The author of the reply. The author's email address and - // permission ID will not be populated. + // Author: Output only. The author of the reply. The author's email + // address and permission ID will not be populated. Author *User `json:"author,omitempty"` // Content: The plain text content of the reply. This field is used for - // setting the content, while htmlContent should be displayed. This is - // required on creates if no action is specified. + // setting the content, while `htmlContent` should be displayed. This is + // required on creates if no `action` is specified. Content string `json:"content,omitempty"` // CreatedTime: The time at which the reply was created (RFC 3339 // date-time). CreatedTime string `json:"createdTime,omitempty"` - // Deleted: Whether the reply has been deleted. A deleted reply has no - // content. + // Deleted: Output only. Whether the reply has been deleted. A deleted + // reply has no content. Deleted bool `json:"deleted,omitempty"` - // HtmlContent: The content of the reply with HTML formatting. + // HtmlContent: Output only. The content of the reply with HTML + // formatting. HtmlContent string `json:"htmlContent,omitempty"` - // Id: The ID of the reply. + // Id: Output only. The ID of the reply. Id string `json:"id,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#reply". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#reply". Kind string `json:"kind,omitempty"` // ModifiedTime: The last time the reply was modified (RFC 3339 @@ -2849,40 +2864,42 @@ func (s *ReplyList) MarshalJSON() ([]byte, error) { // Revision: The metadata for a revision to a file. type Revision struct { - // ExportLinks: Links for exporting Docs Editors files to specific - // formats. + // ExportLinks: Output only. Links for exporting Docs Editors files to + // specific formats. ExportLinks map[string]string `json:"exportLinks,omitempty"` - // Id: The ID of the revision. + // Id: Output only. The ID of the revision. Id string `json:"id,omitempty"` // KeepForever: 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. + // can be set on a maximum of 200 revisions for a file. This field is + // only applicable to files with binary content in Drive. KeepForever bool `json:"keepForever,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#revision". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#revision". Kind string `json:"kind,omitempty"` - // LastModifyingUser: The last user to modify this revision. + // LastModifyingUser: Output only. The last user to modify this + // revision. LastModifyingUser *User `json:"lastModifyingUser,omitempty"` - // Md5Checksum: The MD5 checksum of the revision's content. This is only - // applicable to files with binary content in Drive. + // Md5Checksum: Output only. The MD5 checksum of the revision's content. + // This is only applicable to files with binary content in Drive. Md5Checksum string `json:"md5Checksum,omitempty"` - // MimeType: The MIME type of the revision. + // MimeType: Output only. The MIME type of the revision. MimeType string `json:"mimeType,omitempty"` // ModifiedTime: The last time the revision was modified (RFC 3339 // date-time). ModifiedTime string `json:"modifiedTime,omitempty"` - // OriginalFilename: The original filename used to create this revision. - // This is only applicable to files with binary content in Drive. + // OriginalFilename: Output only. The original filename used to create + // this revision. This is only applicable to files with binary content + // in Drive. OriginalFilename string `json:"originalFilename,omitempty"` // PublishAuto: Whether subsequent revisions will be automatically @@ -2893,16 +2910,16 @@ type Revision struct { // applicable to Docs Editors files. Published bool `json:"published,omitempty"` - // PublishedLink: A link to the published revision. This is only - // populated for Google Sites files. + // PublishedLink: Output only. A link to the published revision. This is + // only populated for Google Sites files. PublishedLink string `json:"publishedLink,omitempty"` // PublishedOutsideDomain: Whether this revision is published outside // the domain. This is only applicable to Docs Editors files. PublishedOutsideDomain bool `json:"publishedOutsideDomain,omitempty"` - // Size: The size of the revision's content in bytes. This is only - // applicable to files with binary content in Drive. + // Size: Output only. The size of the revision's content in bytes. This + // is only applicable to files with binary content in Drive. Size int64 `json:"size,omitempty,string"` // ServerResponse contains the HTTP response code and headers from the @@ -3015,9 +3032,9 @@ func (s *StartPageToken) MarshalJSON() ([]byte, error) { type TeamDrive struct { // BackgroundImageFile: An image file and cropping parameters from which // a background image for this Team Drive is set. This is a write only - // field; it can only be set on drive.teamdrives.update requests that - // don't set themeId. When specified, all fields of the - // backgroundImageFile must be set. + // field; it can only be set on `drive.teamdrives.update` requests that + // don't set `themeId`. When specified, all fields of the + // `backgroundImageFile` must be set. BackgroundImageFile *TeamDriveBackgroundImageFile `json:"backgroundImageFile,omitempty"` // BackgroundImageLink: A short-lived link to this Team Drive's @@ -3028,8 +3045,8 @@ type TeamDrive struct { Capabilities *TeamDriveCapabilities `json:"capabilities,omitempty"` // ColorRgb: 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. + // only be set on a `drive.teamdrives.update` request that does not set + // `themeId`. ColorRgb string `json:"colorRgb,omitempty"` // CreatedTime: The time at which the Team Drive was created (RFC 3339 @@ -3048,8 +3065,8 @@ type TeamDrive struct { Name string `json:"name,omitempty"` // OrgUnitId: The organizational unit of this shared drive. This field - // is only populated on drives.list responses when the - // useDomainAdminAccess parameter is set to true. + // is only populated on `drives.list` responses when the + // `useDomainAdminAccess` parameter is set to `true`. OrgUnitId string `json:"orgUnitId,omitempty"` // Restrictions: A set of restrictions that apply to this Team Drive or @@ -3057,12 +3074,12 @@ type TeamDrive struct { Restrictions *TeamDriveRestrictions `json:"restrictions,omitempty"` // ThemeId: 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. + // 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`. ThemeId string `json:"themeId,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -3095,9 +3112,9 @@ func (s *TeamDrive) MarshalJSON() ([]byte, error) { // TeamDriveBackgroundImageFile: An image file and cropping parameters // from which a background image for this Team Drive is set. This is a -// write only field; it can only be set on drive.teamdrives.update -// requests that don't set themeId. When specified, all fields of the -// backgroundImageFile must be set. +// write only field; it can only be set on `drive.teamdrives.update` +// requests that don't set `themeId`. When specified, all fields of the +// `backgroundImageFile` must be set. type TeamDriveBackgroundImageFile struct { // Id: The ID of an image file in Drive to use for the background image. Id string `json:"id,omitempty"` @@ -3172,17 +3189,17 @@ type TeamDriveCapabilities struct { CanAddChildren bool `json:"canAddChildren,omitempty"` // CanChangeCopyRequiresWriterPermissionRestriction: Whether the current - // user can change the copyRequiresWriterPermission restriction of this - // Team Drive. + // user can change the `copyRequiresWriterPermission` restriction of + // this Team Drive. CanChangeCopyRequiresWriterPermissionRestriction bool `json:"canChangeCopyRequiresWriterPermissionRestriction,omitempty"` // CanChangeDomainUsersOnlyRestriction: Whether the current user can - // change the domainUsersOnly restriction of this Team Drive. + // change the `domainUsersOnly` restriction of this Team Drive. CanChangeDomainUsersOnlyRestriction bool `json:"canChangeDomainUsersOnlyRestriction,omitempty"` // CanChangeSharingFoldersRequiresOrganizerPermissionRestriction: // Whether the current user can change the - // sharingFoldersRequiresOrganizerPermission restriction of this Team + // `sharingFoldersRequiresOrganizerPermission` restriction of this Team // Drive. CanChangeSharingFoldersRequiresOrganizerPermissionRestriction bool `json:"canChangeSharingFoldersRequiresOrganizerPermissionRestriction,omitempty"` @@ -3191,7 +3208,7 @@ type TeamDriveCapabilities struct { CanChangeTeamDriveBackground bool `json:"canChangeTeamDriveBackground,omitempty"` // CanChangeTeamMembersOnlyRestriction: Whether the current user can - // change the teamMembersOnly restriction of this Team Drive. + // change the `teamMembersOnly` restriction of this Team Drive. CanChangeTeamMembersOnlyRestriction bool `json:"canChangeTeamMembersOnlyRestriction,omitempty"` // CanComment: Whether the current user can comment on files in this @@ -3229,8 +3246,8 @@ type TeamDriveCapabilities struct { // resource of files in this Team Drive. CanReadRevisions bool `json:"canReadRevisions,omitempty"` - // CanRemoveChildren: Deprecated - use canDeleteChildren or - // canTrashChildren instead. + // CanRemoveChildren: Deprecated: Use `canDeleteChildren` or + // `canTrashChildren` instead. CanRemoveChildren bool `json:"canRemoveChildren,omitempty"` // CanRename: Whether the current user can rename files or folders in @@ -3286,8 +3303,8 @@ type TeamDriveRestrictions struct { // CopyRequiresWriterPermission: 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 + // 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. CopyRequiresWriterPermission bool `json:"copyRequiresWriterPermission,omitempty"` @@ -3377,25 +3394,28 @@ func (s *TeamDriveList) MarshalJSON() ([]byte, error) { // User: Information about a Drive user. type User struct { - // DisplayName: A plain text displayable name for this user. + // DisplayName: Output only. A plain text displayable name for this + // user. DisplayName string `json:"displayName,omitempty"` - // EmailAddress: 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. + // EmailAddress: 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. EmailAddress string `json:"emailAddress,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#user". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#user". Kind string `json:"kind,omitempty"` - // Me: Whether this user is the requesting user. + // Me: Output only. Whether this user is the requesting user. Me bool `json:"me,omitempty"` - // PermissionId: The user's ID as visible in Permission resources. + // PermissionId: Output only. The user's ID as visible in Permission + // resources. PermissionId string `json:"permissionId,omitempty"` - // PhotoLink: A link to the user's profile photo, if available. + // PhotoLink: Output only. A link to the user's profile photo, if + // available. PhotoLink string `json:"photoLink,omitempty"` // ForceSendFields is a list of field names (e.g. "DisplayName") to @@ -3486,7 +3506,7 @@ func (c *AboutGetCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "about") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/about") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -3535,9 +3555,12 @@ func (c *AboutGetCall) Do(opts ...googleapi.CallOption) (*About, error) { return ret, nil // { // "description": "Gets information about the user, the user's Drive, and system capabilities.", + // "flatPath": "drive/v3/about", // "httpMethod": "GET", // "id": "drive.about.get", - // "path": "about", + // "parameterOrder": [], + // "parameters": {}, + // "path": "drive/v3/about", // "response": { // "$ref": "About" // }, @@ -3573,7 +3596,7 @@ func (r *ChangesService) GetStartPageToken() *ChangesGetStartPageTokenCall { // DriveId sets the optional parameter "driveId": The ID of the shared // drive for which the starting pageToken for listing future changes -// from that shared drive is returned. +// from that shared drive will be returned. func (c *ChangesGetStartPageTokenCall) DriveId(driveId string) *ChangesGetStartPageTokenCall { c.urlParams_.Set("driveId", driveId) return c @@ -3588,14 +3611,14 @@ func (c *ChangesGetStartPageTokenCall) SupportsAllDrives(supportsAllDrives bool) } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *ChangesGetStartPageTokenCall) SupportsTeamDrives(supportsTeamDrives bool) *ChangesGetStartPageTokenCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *ChangesGetStartPageTokenCall) TeamDriveId(teamDriveId string) *ChangesGetStartPageTokenCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -3649,7 +3672,7 @@ func (c *ChangesGetStartPageTokenCall) doRequest(alt string) (*http.Response, er var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "changes/startPageToken") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/changes/startPageToken") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -3698,11 +3721,13 @@ func (c *ChangesGetStartPageTokenCall) Do(opts ...googleapi.CallOption) (*StartP return ret, nil // { // "description": "Gets the starting pageToken for listing future changes.", + // "flatPath": "drive/v3/changes/startPageToken", // "httpMethod": "GET", // "id": "drive.changes.getStartPageToken", + // "parameterOrder": [], // "parameters": { // "driveId": { - // "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.", + // "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.", // "location": "query", // "type": "string" // }, @@ -3714,17 +3739,17 @@ func (c *ChangesGetStartPageTokenCall) Do(opts ...googleapi.CallOption) (*StartP // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } // }, - // "path": "changes/startPageToken", + // "path": "drive/v3/changes/startPageToken", // "response": { // "$ref": "StartPageToken" // }, @@ -3764,7 +3789,7 @@ func (r *ChangesService) List(pageToken string) *ChangesListCall { } // DriveId sets the optional parameter "driveId": The shared drive from -// which changes are returned. If specified the change IDs will be +// 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. func (c *ChangesListCall) DriveId(driveId string) *ChangesListCall { @@ -3791,7 +3816,7 @@ func (c *ChangesListCall) IncludeItemsFromAllDrives(includeItemsFromAllDrives bo } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *ChangesListCall) IncludeLabels(includeLabels string) *ChangesListCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -3816,7 +3841,7 @@ func (c *ChangesListCall) IncludeRemoved(includeRemoved bool) *ChangesListCall { } // IncludeTeamDriveItems sets the optional parameter -// "includeTeamDriveItems": Deprecated use includeItemsFromAllDrives +// "includeTeamDriveItems": Deprecated: Use `includeItemsFromAllDrives` // instead. func (c *ChangesListCall) IncludeTeamDriveItems(includeTeamDriveItems bool) *ChangesListCall { c.urlParams_.Set("includeTeamDriveItems", fmt.Sprint(includeTeamDriveItems)) @@ -3857,14 +3882,14 @@ func (c *ChangesListCall) SupportsAllDrives(supportsAllDrives bool) *ChangesList } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *ChangesListCall) SupportsTeamDrives(supportsTeamDrives bool) *ChangesListCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *ChangesListCall) TeamDriveId(teamDriveId string) *ChangesListCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -3918,7 +3943,7 @@ func (c *ChangesListCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "changes") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/changes") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -3967,6 +3992,7 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) return ret, nil // { // "description": "Lists the changes for a user or shared drive.", + // "flatPath": "drive/v3/changes", // "httpMethod": "GET", // "id": "drive.changes.list", // "parameterOrder": [ @@ -3974,7 +4000,7 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) // ], // "parameters": { // "driveId": { - // "description": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", + // "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.", // "location": "query", // "type": "string" // }, @@ -3991,7 +4017,7 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -4008,7 +4034,7 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) // }, // "includeTeamDriveItems": { // "default": "false", - // "description": "Deprecated use includeItemsFromAllDrives instead.", + // "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -4047,17 +4073,17 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } // }, - // "path": "changes", + // "path": "drive/v3/changes", // "response": { // "$ref": "ChangeList" // }, @@ -4085,8 +4111,7 @@ type ChangesWatchCall struct { header_ http.Header } -// Watch: Subscribes to changes for a user. To use this method, you must -// include the pageToken query parameter. +// Watch: Subscribes to changes for a user. // // - pageToken: The token for continuing a previous list request on the // next page. This should be set to the value of 'nextPageToken' from @@ -4100,7 +4125,7 @@ func (r *ChangesService) Watch(pageToken string, channel *Channel) *ChangesWatch } // DriveId sets the optional parameter "driveId": The shared drive from -// which changes are returned. If specified the change IDs will be +// 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. func (c *ChangesWatchCall) DriveId(driveId string) *ChangesWatchCall { @@ -4127,7 +4152,7 @@ func (c *ChangesWatchCall) IncludeItemsFromAllDrives(includeItemsFromAllDrives b } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *ChangesWatchCall) IncludeLabels(includeLabels string) *ChangesWatchCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -4152,7 +4177,7 @@ func (c *ChangesWatchCall) IncludeRemoved(includeRemoved bool) *ChangesWatchCall } // IncludeTeamDriveItems sets the optional parameter -// "includeTeamDriveItems": Deprecated use includeItemsFromAllDrives +// "includeTeamDriveItems": Deprecated: Use `includeItemsFromAllDrives` // instead. func (c *ChangesWatchCall) IncludeTeamDriveItems(includeTeamDriveItems bool) *ChangesWatchCall { c.urlParams_.Set("includeTeamDriveItems", fmt.Sprint(includeTeamDriveItems)) @@ -4193,14 +4218,14 @@ func (c *ChangesWatchCall) SupportsAllDrives(supportsAllDrives bool) *ChangesWat } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *ChangesWatchCall) SupportsTeamDrives(supportsTeamDrives bool) *ChangesWatchCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *ChangesWatchCall) TeamDriveId(teamDriveId string) *ChangesWatchCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -4246,7 +4271,7 @@ func (c *ChangesWatchCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "changes/watch") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/changes/watch") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("POST", urls, body) if err != nil { @@ -4294,7 +4319,8 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { } return ret, nil // { - // "description": "Subscribes to changes for a user. To use this method, you must include the pageToken query parameter.", + // "description": "Subscribes to changes for a user.", + // "flatPath": "drive/v3/changes/watch", // "httpMethod": "POST", // "id": "drive.changes.watch", // "parameterOrder": [ @@ -4302,7 +4328,7 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // ], // "parameters": { // "driveId": { - // "description": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", + // "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.", // "location": "query", // "type": "string" // }, @@ -4319,7 +4345,7 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -4336,7 +4362,7 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // }, // "includeTeamDriveItems": { // "default": "false", - // "description": "Deprecated use includeItemsFromAllDrives instead.", + // "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -4375,17 +4401,17 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } // }, - // "path": "changes/watch", + // "path": "drive/v3/changes/watch", // "request": { // "$ref": "Channel", // "parameterName": "resource" @@ -4417,7 +4443,7 @@ type ChannelsStopCall struct { header_ http.Header } -// Stop: Stop watching resources through this channel +// Stop: Stop watching resources through this channel. func (r *ChannelsService) Stop(channel *Channel) *ChannelsStopCall { c := &ChannelsStopCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.channel = channel @@ -4464,7 +4490,7 @@ func (c *ChannelsStopCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "channels/stop") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/channels/stop") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("POST", urls, body) if err != nil { @@ -4487,10 +4513,13 @@ func (c *ChannelsStopCall) Do(opts ...googleapi.CallOption) error { } return nil // { - // "description": "Stop watching resources through this channel", + // "description": "Stop watching resources through this channel.", + // "flatPath": "drive/v3/channels/stop", // "httpMethod": "POST", // "id": "drive.channels.stop", - // "path": "channels/stop", + // "parameterOrder": [], + // "parameters": {}, + // "path": "drive/v3/channels/stop", // "request": { // "$ref": "Channel", // "parameterName": "resource" @@ -4569,7 +4598,7 @@ func (c *CommentsCreateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/comments") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/comments") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("POST", urls, body) if err != nil { @@ -4621,6 +4650,7 @@ func (c *CommentsCreateCall) Do(opts ...googleapi.CallOption) (*Comment, error) return ret, nil // { // "description": "Creates a comment on a file.", + // "flatPath": "drive/v3/files/{fileId}/comments", // "httpMethod": "POST", // "id": "drive.comments.create", // "parameterOrder": [ @@ -4634,7 +4664,7 @@ func (c *CommentsCreateCall) Do(opts ...googleapi.CallOption) (*Comment, error) // "type": "string" // } // }, - // "path": "files/{fileId}/comments", + // "path": "drive/v3/files/{fileId}/comments", // "request": { // "$ref": "Comment" // }, @@ -4706,7 +4736,7 @@ func (c *CommentsDeleteCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/comments/{commentId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/comments/{commentId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("DELETE", urls, body) if err != nil { @@ -4734,6 +4764,7 @@ func (c *CommentsDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Deletes a comment.", + // "flatPath": "drive/v3/files/{fileId}/comments/{commentId}", // "httpMethod": "DELETE", // "id": "drive.comments.delete", // "parameterOrder": [ @@ -4754,7 +4785,7 @@ func (c *CommentsDeleteCall) Do(opts ...googleapi.CallOption) error { // "type": "string" // } // }, - // "path": "files/{fileId}/comments/{commentId}", + // "path": "drive/v3/files/{fileId}/comments/{commentId}", // "scopes": [ // "https://www.googleapis.com/auth/drive", // "https://www.googleapis.com/auth/drive.file" @@ -4842,7 +4873,7 @@ func (c *CommentsGetCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/comments/{commentId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/comments/{commentId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -4895,6 +4926,7 @@ func (c *CommentsGetCall) Do(opts ...googleapi.CallOption) (*Comment, error) { return ret, nil // { // "description": "Gets a comment by ID.", + // "flatPath": "drive/v3/files/{fileId}/comments/{commentId}", // "httpMethod": "GET", // "id": "drive.comments.get", // "parameterOrder": [ @@ -4921,7 +4953,7 @@ func (c *CommentsGetCall) Do(opts ...googleapi.CallOption) (*Comment, error) { // "type": "boolean" // } // }, - // "path": "files/{fileId}/comments/{commentId}", + // "path": "drive/v3/files/{fileId}/comments/{commentId}", // "response": { // "$ref": "Comment" // }, @@ -5033,7 +5065,7 @@ func (c *CommentsListCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/comments") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/comments") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -5085,6 +5117,7 @@ func (c *CommentsListCall) Do(opts ...googleapi.CallOption) (*CommentList, error return ret, nil // { // "description": "Lists a file's comments.", + // "flatPath": "drive/v3/files/{fileId}/comments", // "httpMethod": "GET", // "id": "drive.comments.list", // "parameterOrder": [ @@ -5123,7 +5156,7 @@ func (c *CommentsListCall) Do(opts ...googleapi.CallOption) (*CommentList, error // "type": "string" // } // }, - // "path": "files/{fileId}/comments", + // "path": "drive/v3/files/{fileId}/comments", // "response": { // "$ref": "CommentList" // }, @@ -5221,7 +5254,7 @@ func (c *CommentsUpdateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/comments/{commentId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/comments/{commentId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("PATCH", urls, body) if err != nil { @@ -5274,6 +5307,7 @@ func (c *CommentsUpdateCall) Do(opts ...googleapi.CallOption) (*Comment, error) return ret, nil // { // "description": "Updates a comment with patch semantics.", + // "flatPath": "drive/v3/files/{fileId}/comments/{commentId}", // "httpMethod": "PATCH", // "id": "drive.comments.update", // "parameterOrder": [ @@ -5294,7 +5328,7 @@ func (c *CommentsUpdateCall) Do(opts ...googleapi.CallOption) (*Comment, error) // "type": "string" // } // }, - // "path": "files/{fileId}/comments/{commentId}", + // "path": "drive/v3/files/{fileId}/comments/{commentId}", // "request": { // "$ref": "Comment" // }, @@ -5374,7 +5408,7 @@ func (c *DrivesCreateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "drives") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/drives") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("POST", urls, body) if err != nil { @@ -5423,6 +5457,7 @@ func (c *DrivesCreateCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Creates a shared drive.", + // "flatPath": "drive/v3/drives", // "httpMethod": "POST", // "id": "drive.drives.create", // "parameterOrder": [ @@ -5436,7 +5471,7 @@ func (c *DrivesCreateCall) Do(opts ...googleapi.CallOption) (*Drive, error) { // "type": "string" // } // }, - // "path": "drives", + // "path": "drive/v3/drives", // "request": { // "$ref": "Drive" // }, @@ -5472,8 +5507,8 @@ func (r *DrivesService) Delete(driveId string) *DrivesDeleteCall { // AllowItemDeletion sets the optional parameter "allowItemDeletion": // Whether any items inside the shared drive should also be deleted. -// This option is only supported when useDomainAdminAccess is also set -// to true. +// This option is only supported when `useDomainAdminAccess` is also set +// to `true`. func (c *DrivesDeleteCall) AllowItemDeletion(allowItemDeletion bool) *DrivesDeleteCall { c.urlParams_.Set("allowItemDeletion", fmt.Sprint(allowItemDeletion)) return c @@ -5523,7 +5558,7 @@ func (c *DrivesDeleteCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "drives/{driveId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/drives/{driveId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("DELETE", urls, body) if err != nil { @@ -5550,6 +5585,7 @@ func (c *DrivesDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.", + // "flatPath": "drive/v3/drives/{driveId}", // "httpMethod": "DELETE", // "id": "drive.drives.delete", // "parameterOrder": [ @@ -5558,7 +5594,7 @@ func (c *DrivesDeleteCall) Do(opts ...googleapi.CallOption) error { // "parameters": { // "allowItemDeletion": { // "default": "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.", + // "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`.", // "location": "query", // "type": "boolean" // }, @@ -5575,7 +5611,7 @@ func (c *DrivesDeleteCall) Do(opts ...googleapi.CallOption) error { // "type": "boolean" // } // }, - // "path": "drives/{driveId}", + // "path": "drive/v3/drives/{driveId}", // "scopes": [ // "https://www.googleapis.com/auth/drive" // ] @@ -5660,7 +5696,7 @@ func (c *DrivesGetCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "drives/{driveId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/drives/{driveId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -5712,6 +5748,7 @@ func (c *DrivesGetCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Gets a shared drive's metadata by ID.", + // "flatPath": "drive/v3/drives/{driveId}", // "httpMethod": "GET", // "id": "drive.drives.get", // "parameterOrder": [ @@ -5731,7 +5768,7 @@ func (c *DrivesGetCall) Do(opts ...googleapi.CallOption) (*Drive, error) { // "type": "boolean" // } // }, - // "path": "drives/{driveId}", + // "path": "drive/v3/drives/{driveId}", // "response": { // "$ref": "Drive" // }, @@ -5797,7 +5834,7 @@ func (c *DrivesHideCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "drives/{driveId}/hide") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/drives/{driveId}/hide") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("POST", urls, body) if err != nil { @@ -5849,6 +5886,7 @@ func (c *DrivesHideCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Hides a shared drive from the default view.", + // "flatPath": "drive/v3/drives/{driveId}/hide", // "httpMethod": "POST", // "id": "drive.drives.hide", // "parameterOrder": [ @@ -5862,7 +5900,7 @@ func (c *DrivesHideCall) Do(opts ...googleapi.CallOption) (*Drive, error) { // "type": "string" // } // }, - // "path": "drives/{driveId}/hide", + // "path": "drive/v3/drives/{driveId}/hide", // "response": { // "$ref": "Drive" // }, @@ -5883,7 +5921,10 @@ type DrivesListCall struct { header_ http.Header } -// List: Lists the user's shared drives. +// List: 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 +// (/drive/api/guides/search-shareddrives) guide. func (r *DrivesService) List() *DrivesListCall { c := &DrivesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} return c @@ -5967,7 +6008,7 @@ func (c *DrivesListCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "drives") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/drives") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -6015,9 +6056,11 @@ func (c *DrivesListCall) Do(opts ...googleapi.CallOption) (*DriveList, error) { } return ret, nil // { - // "description": "Lists the user's shared drives.", + // "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](/drive/api/guides/search-shareddrives) guide.", + // "flatPath": "drive/v3/drives", // "httpMethod": "GET", // "id": "drive.drives.list", + // "parameterOrder": [], // "parameters": { // "pageSize": { // "default": "10", @@ -6045,7 +6088,7 @@ func (c *DrivesListCall) Do(opts ...googleapi.CallOption) (*DriveList, error) { // "type": "boolean" // } // }, - // "path": "drives", + // "path": "drive/v3/drives", // "response": { // "$ref": "DriveList" // }, @@ -6132,7 +6175,7 @@ func (c *DrivesUnhideCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "drives/{driveId}/unhide") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/drives/{driveId}/unhide") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("POST", urls, body) if err != nil { @@ -6184,6 +6227,7 @@ func (c *DrivesUnhideCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Restores a shared drive to the default view.", + // "flatPath": "drive/v3/drives/{driveId}/unhide", // "httpMethod": "POST", // "id": "drive.drives.unhide", // "parameterOrder": [ @@ -6197,7 +6241,7 @@ func (c *DrivesUnhideCall) Do(opts ...googleapi.CallOption) (*Drive, error) { // "type": "string" // } // }, - // "path": "drives/{driveId}/unhide", + // "path": "drive/v3/drives/{driveId}/unhide", // "response": { // "$ref": "Drive" // }, @@ -6219,7 +6263,7 @@ type DrivesUpdateCall struct { header_ http.Header } -// Update: Updates the metadata for a shared drive. +// Update: Updates the metadate for a shared drive. // // - driveId: The ID of the shared drive. func (r *DrivesService) Update(driveId string, drive *Drive) *DrivesUpdateCall { @@ -6230,9 +6274,9 @@ func (r *DrivesService) Update(driveId string, drive *Drive) *DrivesUpdateCall { } // UseDomainAdminAccess sets the optional parameter -// "useDomainAdminAccess": Issue the request as a domain administrator. -// If set to true, then the requester is granted access if they're an -// administrator of the domain to which the shared drive belongs. +// "useDomainAdminAccess": 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. func (c *DrivesUpdateCall) UseDomainAdminAccess(useDomainAdminAccess bool) *DrivesUpdateCall { c.urlParams_.Set("useDomainAdminAccess", fmt.Sprint(useDomainAdminAccess)) return c @@ -6278,7 +6322,7 @@ func (c *DrivesUpdateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "drives/{driveId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/drives/{driveId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("PATCH", urls, body) if err != nil { @@ -6329,7 +6373,8 @@ func (c *DrivesUpdateCall) Do(opts ...googleapi.CallOption) (*Drive, error) { } return ret, nil // { - // "description": "Updates the metadata for a shared drive.", + // "description": "Updates the metadate for a shared drive.", + // "flatPath": "drive/v3/drives/{driveId}", // "httpMethod": "PATCH", // "id": "drive.drives.update", // "parameterOrder": [ @@ -6344,12 +6389,12 @@ func (c *DrivesUpdateCall) Do(opts ...googleapi.CallOption) (*Drive, error) { // }, // "useDomainAdminAccess": { // "default": "false", - // "description": "Issue the request as a domain administrator. If set to true, then the requester is granted access if they're an administrator of the domain to which the shared drive belongs.", + // "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.", // "location": "query", // "type": "boolean" // } // }, - // "path": "drives/{driveId}", + // "path": "drive/v3/drives/{driveId}", // "request": { // "$ref": "Drive" // }, @@ -6375,7 +6420,7 @@ type FilesCopyCall struct { } // Copy: Creates a copy of a file and applies any requested updates with -// patch semantics. Folders cannot be copied. +// patch semantics. // // - fileId: The ID of the file. func (r *FilesService) Copy(fileId string, file *File) *FilesCopyCall { @@ -6405,7 +6450,7 @@ func (c *FilesCopyCall) IgnoreDefaultVisibility(ignoreDefaultVisibility bool) *F } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesCopyCall) IncludeLabels(includeLabels string) *FilesCopyCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -6447,7 +6492,7 @@ func (c *FilesCopyCall) SupportsAllDrives(supportsAllDrives bool) *FilesCopyCall } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesCopyCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesCopyCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -6493,7 +6538,7 @@ func (c *FilesCopyCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/copy") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/copy") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("POST", urls, body) if err != nil { @@ -6544,7 +6589,8 @@ func (c *FilesCopyCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.", + // "description": "Creates a copy of a file and applies any requested updates with patch semantics.", + // "flatPath": "drive/v3/files/{fileId}/copy", // "httpMethod": "POST", // "id": "drive.files.copy", // "parameterOrder": [ @@ -6570,7 +6616,7 @@ func (c *FilesCopyCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -6598,12 +6644,12 @@ func (c *FilesCopyCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } // }, - // "path": "files/{fileId}/copy", + // "path": "drive/v3/files/{fileId}/copy", // "request": { // "$ref": "File" // }, @@ -6631,7 +6677,25 @@ type FilesCreateCall struct { header_ http.Header } -// Create: Creates a file. +// Create: Creates a new file. This method supports an */upload* URI +// and accepts uploaded media with the following characteristics: - +// *Maximum file size:* 5120GB - *Accepted Media MIME types:*`*/*` Note: +// 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 further information on uploading files, refer to +// Upload files (/drive/api/guides/manage-uploads). Apps creating +// shortcuts with `files.create` 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 `title` 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 title. In cases where the extension is +// missing, Google Drive attempts to determine the extension based on +// the file's MIME type. func (r *FilesService) Create(file *File) *FilesCreateCall { c := &FilesCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.file = file @@ -6658,7 +6722,7 @@ func (c *FilesCreateCall) IgnoreDefaultVisibility(ignoreDefaultVisibility bool) } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesCreateCall) IncludeLabels(includeLabels string) *FilesCreateCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -6700,7 +6764,7 @@ func (c *FilesCreateCall) SupportsAllDrives(supportsAllDrives bool) *FilesCreate } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesCreateCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesCreateCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -6793,7 +6857,7 @@ func (c *FilesCreateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files") if c.mediaInfo_ != nil { urls = googleapi.ResolveRelative(c.s.BasePath, "/upload/drive/v3/files") c.urlParams_.Set("uploadType", c.mediaInfo_.UploadType()) @@ -6869,14 +6933,15 @@ func (c *FilesCreateCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Creates a file.", + // "description": " Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5120GB - *Accepted Media MIME types:*`*/*` Note: 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 further information on uploading files, refer to [Upload files](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` 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 `title` 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 title. In cases where the extension is missing, Google Drive attempts to determine the extension based on the file's MIME type.", + // "flatPath": "drive/v3/files", // "httpMethod": "POST", // "id": "drive.files.create", // "mediaUpload": { // "accept": [ // "*/*" // ], - // "maxSize": "5120GB", + // "maxSize": "5497558138880", // "protocols": { // "resumable": { // "multipart": true, @@ -6888,6 +6953,7 @@ func (c *FilesCreateCall) Do(opts ...googleapi.CallOption) (*File, error) { // } // } // }, + // "parameterOrder": [], // "parameters": { // "enforceSingleParent": { // "default": "false", @@ -6902,7 +6968,7 @@ func (c *FilesCreateCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -6930,7 +6996,7 @@ func (c *FilesCreateCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -6941,7 +7007,7 @@ func (c *FilesCreateCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "boolean" // } // }, - // "path": "files", + // "path": "drive/v3/files", // "request": { // "$ref": "File" // }, @@ -6953,8 +7019,7 @@ func (c *FilesCreateCall) Do(opts ...googleapi.CallOption) (*File, error) { // "https://www.googleapis.com/auth/drive.appdata", // "https://www.googleapis.com/auth/drive.file" // ], - // "supportsMediaUpload": true, - // "supportsSubscription": true + // "supportsMediaUpload": true // } } @@ -6982,7 +7047,7 @@ func (r *FilesService) Delete(fileId string) *FilesDeleteCall { } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. If an item is not in a shared +// "enforceSingleParent": Deprecated: If an item is not in a shared // drive and its last parent is deleted but the item itself is not, the // item will be placed under its owner's root. func (c *FilesDeleteCall) EnforceSingleParent(enforceSingleParent bool) *FilesDeleteCall { @@ -6999,7 +7064,7 @@ func (c *FilesDeleteCall) SupportsAllDrives(supportsAllDrives bool) *FilesDelete } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesDeleteCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesDeleteCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -7040,7 +7105,7 @@ func (c *FilesDeleteCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("DELETE", urls, body) if err != nil { @@ -7067,6 +7132,7 @@ func (c *FilesDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.", + // "flatPath": "drive/v3/files/{fileId}", // "httpMethod": "DELETE", // "id": "drive.files.delete", // "parameterOrder": [ @@ -7075,7 +7141,7 @@ func (c *FilesDeleteCall) Do(opts ...googleapi.CallOption) error { // "parameters": { // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", + // "description": "Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", // "location": "query", // "type": "boolean" // }, @@ -7093,12 +7159,12 @@ func (c *FilesDeleteCall) Do(opts ...googleapi.CallOption) error { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } // }, - // "path": "files/{fileId}", + // "path": "drive/v3/files/{fileId}", // "scopes": [ // "https://www.googleapis.com/auth/drive", // "https://www.googleapis.com/auth/drive.appdata", @@ -7117,8 +7183,7 @@ type FilesEmptyTrashCall struct { header_ http.Header } -// EmptyTrash: Permanently deletes all trashed files of a user or shared -// drive. +// EmptyTrash: Permanently deletes all of the user's trashed files. func (r *FilesService) EmptyTrash() *FilesEmptyTrashCall { c := &FilesEmptyTrashCall{s: r.s, urlParams_: make(gensupport.URLParams)} return c @@ -7132,7 +7197,7 @@ func (c *FilesEmptyTrashCall) DriveId(driveId string) *FilesEmptyTrashCall { } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. If an item is not in a shared +// "enforceSingleParent": Deprecated: If an item is not in a shared // drive and its last parent is deleted but the item itself is not, the // item will be placed under its owner's root. func (c *FilesEmptyTrashCall) EnforceSingleParent(enforceSingleParent bool) *FilesEmptyTrashCall { @@ -7175,7 +7240,7 @@ func (c *FilesEmptyTrashCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/trash") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/trash") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("DELETE", urls, body) if err != nil { @@ -7198,9 +7263,11 @@ func (c *FilesEmptyTrashCall) Do(opts ...googleapi.CallOption) error { } return nil // { - // "description": "Permanently deletes all trashed files of a user or shared drive.", + // "description": "Permanently deletes all of the user's trashed files.", + // "flatPath": "drive/v3/files/trash", // "httpMethod": "DELETE", // "id": "drive.files.emptyTrash", + // "parameterOrder": [], // "parameters": { // "driveId": { // "description": "If set, empties the trash of the provided shared drive.", @@ -7209,12 +7276,12 @@ func (c *FilesEmptyTrashCall) Do(opts ...googleapi.CallOption) error { // }, // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", + // "description": "Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", // "location": "query", // "type": "boolean" // } // }, - // "path": "files/trash", + // "path": "drive/v3/files/trash", // "scopes": [ // "https://www.googleapis.com/auth/drive" // ] @@ -7294,7 +7361,7 @@ func (c *FilesExportCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/export") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/export") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -7337,6 +7404,7 @@ func (c *FilesExportCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.", + // "flatPath": "drive/v3/files/{fileId}/export", // "httpMethod": "GET", // "id": "drive.files.export", // "parameterOrder": [ @@ -7357,13 +7425,14 @@ func (c *FilesExportCall) Do(opts ...googleapi.CallOption) error { // "type": "string" // } // }, - // "path": "files/{fileId}/export", + // "path": "drive/v3/files/{fileId}/export", // "scopes": [ // "https://www.googleapis.com/auth/drive", // "https://www.googleapis.com/auth/drive.file", // "https://www.googleapis.com/auth/drive.readonly" // ], - // "supportsMediaDownload": true + // "supportsMediaDownload": true, + // "useMediaDownloadService": true // } } @@ -7402,7 +7471,7 @@ func (c *FilesGenerateIdsCall) Space(space string) *FilesGenerateIdsCall { // Type sets the optional parameter "type": 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'. +// Note that 'shortcuts' are only supported in the `drive` 'space'. // (Default: 'files') func (c *FilesGenerateIdsCall) Type(type_ string) *FilesGenerateIdsCall { c.urlParams_.Set("type", type_) @@ -7457,7 +7526,7 @@ func (c *FilesGenerateIdsCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/generateIds") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/generateIds") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -7506,8 +7575,10 @@ func (c *FilesGenerateIdsCall) Do(opts ...googleapi.CallOption) (*GeneratedIds, return ret, nil // { // "description": "Generates a set of file IDs which can be provided in create or copy requests.", + // "flatPath": "drive/v3/files/generateIds", // "httpMethod": "GET", // "id": "drive.files.generateIds", + // "parameterOrder": [], // "parameters": { // "count": { // "default": "10", @@ -7526,12 +7597,12 @@ func (c *FilesGenerateIdsCall) Do(opts ...googleapi.CallOption) (*GeneratedIds, // }, // "type": { // "default": "files", - // "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')", + // "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')", // "location": "query", // "type": "string" // } // }, - // "path": "files/generateIds", + // "path": "drive/v3/files/generateIds", // "response": { // "$ref": "GeneratedIds" // }, @@ -7555,7 +7626,13 @@ type FilesGetCall struct { header_ http.Header } -// Get: Gets a file's metadata or content by ID. +// Get: Gets a file's metadata or content by ID. 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` (/drive/api/reference/rest/v3/files/export) +// instead. For further information on downloading files, refer to +// Download files (/drive/api/guides/manage-downloads). // // - fileId: The ID of the file. func (r *FilesService) Get(fileId string) *FilesGetCall { @@ -7574,7 +7651,7 @@ func (c *FilesGetCall) AcknowledgeAbuse(acknowledgeAbuse bool) *FilesGetCall { } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesGetCall) IncludeLabels(includeLabels string) *FilesGetCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -7599,7 +7676,7 @@ func (c *FilesGetCall) SupportsAllDrives(supportsAllDrives bool) *FilesGetCall { } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesGetCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesGetCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -7653,7 +7730,7 @@ func (c *FilesGetCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -7720,7 +7797,8 @@ func (c *FilesGetCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Gets a file's metadata or content by ID.", + // "description": " Gets a file's metadata or content by ID. 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`](/drive/api/reference/rest/v3/files/export) instead. For further information on downloading files, refer to [Download files](/drive/api/guides/manage-downloads).", + // "flatPath": "drive/v3/files/{fileId}", // "httpMethod": "GET", // "id": "drive.files.get", // "parameterOrder": [ @@ -7740,7 +7818,7 @@ func (c *FilesGetCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -7757,12 +7835,12 @@ func (c *FilesGetCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } // }, - // "path": "files/{fileId}", + // "path": "drive/v3/files/{fileId}", // "response": { // "$ref": "File" // }, @@ -7792,35 +7870,34 @@ type FilesListCall struct { header_ http.Header } -// List: Lists or searches files. +// List: Lists the user's files. This method accepts the `q` parameter, +// which is a search query combining one or more search terms. For more +// information, see the Search for files +// (/drive/api/guides/search-files) guide. *Note:* 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 filter trashed files from the results. func (r *FilesService) List() *FilesListCall { c := &FilesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} return c } -// Corpora sets the optional parameter "corpora": Groupings of files to -// which the query applies. Supported groupings are: 'user' (files -// created by, opened by, or shared directly with the user), 'drive' -// (files in the specified shared drive as indicated by the 'driveId'), -// 'domain' (files shared to the user's domain), and 'allDrives' (A -// combination of 'user' and 'drive' for all drives where the user is a -// member). When able, use 'user' or 'drive', instead of 'allDrives', -// for efficiency. +// Corpora sets the optional parameter "corpora": Bodies of items +// (files/documents) to which the query applies. Supported bodies are +// 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' +// to 'allDrives' for efficiency. func (c *FilesListCall) Corpora(corpora string) *FilesListCall { c.urlParams_.Set("corpora", corpora) return c } -// Corpus sets the optional parameter "corpus": The source of files to -// list. Deprecated: use 'corpora' instead. +// Corpus sets the optional parameter "corpus": Deprecated: The source +// of files to list. Use 'corpora' instead. // // Possible values: // // "domain" - Files shared to the user's domain. -// "user" - Files owned by or shared to the user. If a user has -// -// permissions on a Shared Drive, the files inside it won't be retrieved -// unless the user has created, opened, or shared the file. +// "user" - Files owned by or shared to the user. func (c *FilesListCall) Corpus(corpus string) *FilesListCall { c.urlParams_.Set("corpus", corpus) return c @@ -7842,7 +7919,7 @@ func (c *FilesListCall) IncludeItemsFromAllDrives(includeItemsFromAllDrives bool } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesListCall) IncludeLabels(includeLabels string) *FilesListCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -7859,7 +7936,7 @@ func (c *FilesListCall) IncludePermissionsForView(includePermissionsForView stri } // IncludeTeamDriveItems sets the optional parameter -// "includeTeamDriveItems": Deprecated use includeItemsFromAllDrives +// "includeTeamDriveItems": Deprecated: Use `includeItemsFromAllDrives` // instead. func (c *FilesListCall) IncludeTeamDriveItems(includeTeamDriveItems bool) *FilesListCall { c.urlParams_.Set("includeTeamDriveItems", fmt.Sprint(includeTeamDriveItems)) @@ -7920,14 +7997,14 @@ func (c *FilesListCall) SupportsAllDrives(supportsAllDrives bool) *FilesListCall } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesListCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesListCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *FilesListCall) TeamDriveId(teamDriveId string) *FilesListCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -7981,7 +8058,7 @@ func (c *FilesListCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -8029,24 +8106,26 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { } return ret, nil // { - // "description": "Lists or searches files.", + // "description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files](/drive/api/guides/search-files) guide. *Note:* 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 filter trashed files from the results.", + // "flatPath": "drive/v3/files", // "httpMethod": "GET", // "id": "drive.files.list", + // "parameterOrder": [], // "parameters": { // "corpora": { - // "description": "Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.", + // "description": "Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency.", // "location": "query", // "type": "string" // }, // "corpus": { - // "description": "The source of files to list. Deprecated: use 'corpora' instead.", + // "description": "Deprecated: The source of files to list. Use 'corpora' instead.", // "enum": [ // "domain", // "user" // ], // "enumDescriptions": [ // "Files shared to the user's domain.", - // "Files owned by or shared to the user. If a user has permissions on a Shared Drive, the files inside it won't be retrieved unless the user has created, opened, or shared the file." + // "Files owned by or shared to the user." // ], // "location": "query", // "type": "string" @@ -8063,7 +8142,7 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -8074,7 +8153,7 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { // }, // "includeTeamDriveItems": { // "default": "false", - // "description": "Deprecated use includeItemsFromAllDrives instead.", + // "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -8116,17 +8195,17 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } // }, - // "path": "files", + // "path": "drive/v3/files", // "response": { // "$ref": "FileList" // }, @@ -8177,7 +8256,7 @@ type FilesListLabelsCall struct { // ListLabels: Lists the labels on a file. // -// - fileId: The ID of the file. +// - fileId: The ID for the file or shared drive. func (r *FilesService) ListLabels(fileId string) *FilesListLabelsCall { c := &FilesListLabelsCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.fileId = fileId @@ -8185,8 +8264,7 @@ func (r *FilesService) ListLabels(fileId string) *FilesListLabelsCall { } // MaxResults sets the optional parameter "maxResults": The maximum -// number of labels to return per page. When not set, this defaults to -// 100. +// number of labels to return per page. When not set, defaults to 100. func (c *FilesListLabelsCall) MaxResults(maxResults int64) *FilesListLabelsCall { c.urlParams_.Set("maxResults", fmt.Sprint(maxResults)) return c @@ -8248,7 +8326,7 @@ func (c *FilesListLabelsCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/listLabels") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/listLabels") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -8300,6 +8378,7 @@ func (c *FilesListLabelsCall) Do(opts ...googleapi.CallOption) (*LabelList, erro return ret, nil // { // "description": "Lists the labels on a file.", + // "flatPath": "drive/v3/files/{fileId}/listLabels", // "httpMethod": "GET", // "id": "drive.files.listLabels", // "parameterOrder": [ @@ -8307,14 +8386,14 @@ func (c *FilesListLabelsCall) Do(opts ...googleapi.CallOption) (*LabelList, erro // ], // "parameters": { // "fileId": { - // "description": "The ID of the file.", + // "description": "The ID for the file or shared drive.", // "location": "path", // "required": true, // "type": "string" // }, // "maxResults": { // "default": "100", - // "description": "The maximum number of labels to return per page. When not set, this defaults to 100.", + // "description": "The maximum number of labels to return per page. When not set, defaults to 100.", // "format": "int32", // "location": "query", // "maximum": "100", @@ -8327,7 +8406,7 @@ func (c *FilesListLabelsCall) Do(opts ...googleapi.CallOption) (*LabelList, erro // "type": "string" // } // }, - // "path": "files/{fileId}/listLabels", + // "path": "drive/v3/files/{fileId}/listLabels", // "response": { // "$ref": "LabelList" // }, @@ -8374,9 +8453,10 @@ type FilesModifyLabelsCall struct { header_ http.Header } -// ModifyLabels: Modifies the set of labels on a file. +// ModifyLabels: Modifies the set of labels applied to a file. Returns a +// list of the labels that were added or modified. // -// - fileId: The ID of the file for which the labels are modified. +// - fileId: The ID of the file to which the labels belong. func (r *FilesService) ModifyLabels(fileId string, modifylabelsrequest *ModifyLabelsRequest) *FilesModifyLabelsCall { c := &FilesModifyLabelsCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.fileId = fileId @@ -8424,7 +8504,7 @@ func (c *FilesModifyLabelsCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/modifyLabels") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/modifyLabels") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("POST", urls, body) if err != nil { @@ -8475,7 +8555,8 @@ func (c *FilesModifyLabelsCall) Do(opts ...googleapi.CallOption) (*ModifyLabelsR } return ret, nil // { - // "description": "Modifies the set of labels on a file.", + // "description": "Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.", + // "flatPath": "drive/v3/files/{fileId}/modifyLabels", // "httpMethod": "POST", // "id": "drive.files.modifyLabels", // "parameterOrder": [ @@ -8483,13 +8564,13 @@ func (c *FilesModifyLabelsCall) Do(opts ...googleapi.CallOption) (*ModifyLabelsR // ], // "parameters": { // "fileId": { - // "description": "The ID of the file for which the labels are modified.", + // "description": "The ID of the file to which the labels belong.", // "location": "path", // "required": true, // "type": "string" // } // }, - // "path": "files/{fileId}/modifyLabels", + // "path": "drive/v3/files/{fileId}/modifyLabels", // "request": { // "$ref": "ModifyLabelsRequest" // }, @@ -8517,10 +8598,17 @@ type FilesUpdateCall struct { header_ http.Header } -// Update: Updates a file's metadata and/or content. When calling this +// Update: Updates a file's metadata and/or content. When calling this // method, only populate fields in the request that you want to modify. -// When updating fields, some fields might change automatically, such as -// modifiedDate. This method supports patch semantics. +// 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:* 5120GB - *Accepted +// Media MIME types:*`*/*` Note: 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 further information on +// uploading files, refer to Upload files +// (/drive/api/guides/manage-uploads). // // - fileId: The ID of the file. func (r *FilesService) Update(fileId string, file *File) *FilesUpdateCall { @@ -8538,7 +8626,7 @@ func (c *FilesUpdateCall) AddParents(addParents string) *FilesUpdateCall { } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. Adding files to multiple folders +// "enforceSingleParent": Deprecated: Adding files to multiple folders // is no longer supported. Use shortcuts instead. func (c *FilesUpdateCall) EnforceSingleParent(enforceSingleParent bool) *FilesUpdateCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) @@ -8546,7 +8634,7 @@ func (c *FilesUpdateCall) EnforceSingleParent(enforceSingleParent bool) *FilesUp } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesUpdateCall) IncludeLabels(includeLabels string) *FilesUpdateCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -8595,7 +8683,7 @@ func (c *FilesUpdateCall) SupportsAllDrives(supportsAllDrives bool) *FilesUpdate } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesUpdateCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesUpdateCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -8688,7 +8776,7 @@ func (c *FilesUpdateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}") if c.mediaInfo_ != nil { urls = googleapi.ResolveRelative(c.s.BasePath, "/upload/drive/v3/files/{fileId}") c.urlParams_.Set("uploadType", c.mediaInfo_.UploadType()) @@ -8767,14 +8855,15 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.", + // "description": " Updates a file's metadata and/or content. 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:* 5120GB - *Accepted Media MIME types:*`*/*` Note: 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 further information on uploading files, refer to [Upload files](/drive/api/guides/manage-uploads).", + // "flatPath": "drive/v3/files/{fileId}", // "httpMethod": "PATCH", // "id": "drive.files.update", // "mediaUpload": { // "accept": [ // "*/*" // ], - // "maxSize": "5120GB", + // "maxSize": "5497558138880", // "protocols": { // "resumable": { // "multipart": true, @@ -8797,7 +8886,7 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + // "description": "Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.", // "location": "query", // "type": "boolean" // }, @@ -8808,7 +8897,7 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -8841,7 +8930,7 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -8852,7 +8941,7 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "boolean" // } // }, - // "path": "files/{fileId}", + // "path": "drive/v3/files/{fileId}", // "request": { // "$ref": "File" // }, @@ -8882,7 +8971,7 @@ type FilesWatchCall struct { header_ http.Header } -// Watch: Subscribe to changes on a file. +// Watch: Subscribes to changes to a file. // // - fileId: The ID of the file. func (r *FilesService) Watch(fileId string, channel *Channel) *FilesWatchCall { @@ -8902,7 +8991,7 @@ func (c *FilesWatchCall) AcknowledgeAbuse(acknowledgeAbuse bool) *FilesWatchCall } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesWatchCall) IncludeLabels(includeLabels string) *FilesWatchCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -8927,7 +9016,7 @@ func (c *FilesWatchCall) SupportsAllDrives(supportsAllDrives bool) *FilesWatchCa } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesWatchCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesWatchCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -8941,9 +9030,9 @@ func (c *FilesWatchCall) Fields(s ...googleapi.Field) *FilesWatchCall { return c } -// Context sets the context to be used in this call's Do and Download -// methods. Any pending HTTP request will be aborted if the provided -// context is canceled. +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. func (c *FilesWatchCall) Context(ctx context.Context) *FilesWatchCall { c.ctx_ = ctx return c @@ -8973,7 +9062,7 @@ func (c *FilesWatchCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/watch") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/watch") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("POST", urls, body) if err != nil { @@ -8986,22 +9075,6 @@ func (c *FilesWatchCall) doRequest(alt string) (*http.Response, error) { return gensupport.SendRequest(c.ctx_, c.s.client, req) } -// Download fetches the API endpoint's "media" value, instead of the normal -// API response value. If the returned error is nil, the Response is guaranteed to -// have a 2xx status code. Callers must close the Response.Body as usual. -func (c *FilesWatchCall) Download(opts ...googleapi.CallOption) (*http.Response, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("media") - if err != nil { - return nil, err - } - if err := googleapi.CheckResponse(res); err != nil { - res.Body.Close() - return nil, gensupport.WrapError(err) - } - return res, nil -} - // Do executes the "drive.files.watch" call. // Exactly one of *Channel or error will be non-nil. Any non-2xx status // code is an error. Response headers are in either @@ -9040,7 +9113,8 @@ func (c *FilesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { } return ret, nil // { - // "description": "Subscribe to changes on a file.", + // "description": "Subscribes to changes to a file.", + // "flatPath": "drive/v3/files/{fileId}/watch", // "httpMethod": "POST", // "id": "drive.files.watch", // "parameterOrder": [ @@ -9060,7 +9134,7 @@ func (c *FilesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -9077,12 +9151,12 @@ func (c *FilesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } // }, - // "path": "files/{fileId}/watch", + // "path": "drive/v3/files/{fileId}/watch", // "request": { // "$ref": "Channel", // "parameterName": "resource" @@ -9099,9 +9173,7 @@ func (c *FilesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // "https://www.googleapis.com/auth/drive.photos.readonly", // "https://www.googleapis.com/auth/drive.readonly" // ], - // "supportsMediaDownload": true, - // "supportsSubscription": true, - // "useMediaDownloadService": true + // "supportsSubscription": true // } } @@ -9117,9 +9189,9 @@ type PermissionsCreateCall struct { header_ http.Header } -// Create: Creates a permission for a file or shared drive. For more -// information on creating permissions, see Share files, folders & -// drives. +// Create: Creates a permission for a file or shared drive. **Warning:** +// Concurrent permissions operations on the same file are not supported; +// only the last update is applied. // // - fileId: The ID of the file or shared drive. func (r *PermissionsService) Create(fileId string, permission *Permission) *PermissionsCreateCall { @@ -9137,7 +9209,7 @@ func (c *PermissionsCreateCall) EmailMessage(emailMessage string) *PermissionsCr } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. See moveToNewOwnersRoot for +// "enforceSingleParent": Deprecated: See `moveToNewOwnersRoot` for // details. func (c *PermissionsCreateCall) EnforceSingleParent(enforceSingleParent bool) *PermissionsCreateCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) @@ -9147,9 +9219,9 @@ func (c *PermissionsCreateCall) EnforceSingleParent(enforceSingleParent bool) *P // MoveToNewOwnersRoot sets the optional parameter // "moveToNewOwnersRoot": This parameter will only take effect if the // item is not in a shared drive and the request is attempting to -// transfer the ownership of the item. If set to true, the item will be -// moved to the new owner's My Drive root folder and all prior parents -// removed. If set to false, parents are not changed. +// transfer the ownership of the item. If set to `true`, the item will +// be moved to the new owner's My Drive root folder and all prior +// parents removed. If set to `false`, parents are not changed. func (c *PermissionsCreateCall) MoveToNewOwnersRoot(moveToNewOwnersRoot bool) *PermissionsCreateCall { c.urlParams_.Set("moveToNewOwnersRoot", fmt.Sprint(moveToNewOwnersRoot)) return c @@ -9174,7 +9246,7 @@ func (c *PermissionsCreateCall) SupportsAllDrives(supportsAllDrives bool) *Permi } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsCreateCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsCreateCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -9183,12 +9255,7 @@ func (c *PermissionsCreateCall) SupportsTeamDrives(supportsTeamDrives bool) *Per // TransferOwnership sets the optional parameter "transferOwnership": // 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. File owners can only transfer -// ownership of files existing on My Drive. Files existing in a shared -// drive are owned by the organization that owns that shared drive. -// Ownership transfers are not supported for files and folders in shared -// drives. Organizers of a shared drive can move items from that shared -// drive into their My Drive which transfers the ownership to them. +// acknowledgement of the side effect. func (c *PermissionsCreateCall) TransferOwnership(transferOwnership bool) *PermissionsCreateCall { c.urlParams_.Set("transferOwnership", fmt.Sprint(transferOwnership)) return c @@ -9244,7 +9311,7 @@ func (c *PermissionsCreateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/permissions") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/permissions") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("POST", urls, body) if err != nil { @@ -9295,7 +9362,8 @@ func (c *PermissionsCreateCall) Do(opts ...googleapi.CallOption) (*Permission, e } return ret, nil // { - // "description": "Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders \u0026 drives.", + // "description": "Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + // "flatPath": "drive/v3/files/{fileId}/permissions", // "httpMethod": "POST", // "id": "drive.permissions.create", // "parameterOrder": [ @@ -9309,7 +9377,7 @@ func (c *PermissionsCreateCall) Do(opts ...googleapi.CallOption) (*Permission, e // }, // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. See moveToNewOwnersRoot for details.", + // "description": "Deprecated: See `moveToNewOwnersRoot` for details.", // "location": "query", // "type": "boolean" // }, @@ -9321,7 +9389,7 @@ func (c *PermissionsCreateCall) Do(opts ...googleapi.CallOption) (*Permission, e // }, // "moveToNewOwnersRoot": { // "default": "false", - // "description": "This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents are not changed.", + // "description": "This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not changed.", // "location": "query", // "type": "boolean" // }, @@ -9338,13 +9406,13 @@ func (c *PermissionsCreateCall) Do(opts ...googleapi.CallOption) (*Permission, e // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "transferOwnership": { // "default": "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. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.", + // "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.", // "location": "query", // "type": "boolean" // }, @@ -9355,7 +9423,7 @@ func (c *PermissionsCreateCall) Do(opts ...googleapi.CallOption) (*Permission, e // "type": "boolean" // } // }, - // "path": "files/{fileId}/permissions", + // "path": "drive/v3/files/{fileId}/permissions", // "request": { // "$ref": "Permission" // }, @@ -9381,7 +9449,9 @@ type PermissionsDeleteCall struct { header_ http.Header } -// Delete: Deletes a permission. +// Delete: Deletes a permission. **Warning:** Concurrent permissions +// operations on the same file are not supported; only the last update +// is applied. // // - fileId: The ID of the file or shared drive. // - permissionId: The ID of the permission. @@ -9401,7 +9471,7 @@ func (c *PermissionsDeleteCall) SupportsAllDrives(supportsAllDrives bool) *Permi } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsDeleteCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsDeleteCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -9452,7 +9522,7 @@ func (c *PermissionsDeleteCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/permissions/{permissionId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/permissions/{permissionId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("DELETE", urls, body) if err != nil { @@ -9479,7 +9549,8 @@ func (c *PermissionsDeleteCall) Do(opts ...googleapi.CallOption) error { } return nil // { - // "description": "Deletes a permission.", + // "description": "Deletes a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + // "flatPath": "drive/v3/files/{fileId}/permissions/{permissionId}", // "httpMethod": "DELETE", // "id": "drive.permissions.delete", // "parameterOrder": [ @@ -9507,7 +9578,7 @@ func (c *PermissionsDeleteCall) Do(opts ...googleapi.CallOption) error { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -9518,7 +9589,7 @@ func (c *PermissionsDeleteCall) Do(opts ...googleapi.CallOption) error { // "type": "boolean" // } // }, - // "path": "files/{fileId}/permissions/{permissionId}", + // "path": "drive/v3/files/{fileId}/permissions/{permissionId}", // "scopes": [ // "https://www.googleapis.com/auth/drive", // "https://www.googleapis.com/auth/drive.file" @@ -9559,7 +9630,7 @@ func (c *PermissionsGetCall) SupportsAllDrives(supportsAllDrives bool) *Permissi } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsGetCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsGetCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -9623,7 +9694,7 @@ func (c *PermissionsGetCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/permissions/{permissionId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/permissions/{permissionId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -9676,6 +9747,7 @@ func (c *PermissionsGetCall) Do(opts ...googleapi.CallOption) (*Permission, erro return ret, nil // { // "description": "Gets a permission by ID.", + // "flatPath": "drive/v3/files/{fileId}/permissions/{permissionId}", // "httpMethod": "GET", // "id": "drive.permissions.get", // "parameterOrder": [ @@ -9703,7 +9775,7 @@ func (c *PermissionsGetCall) Do(opts ...googleapi.CallOption) (*Permission, erro // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -9714,7 +9786,7 @@ func (c *PermissionsGetCall) Do(opts ...googleapi.CallOption) (*Permission, erro // "type": "boolean" // } // }, - // "path": "files/{fileId}/permissions/{permissionId}", + // "path": "drive/v3/files/{fileId}/permissions/{permissionId}", // "response": { // "$ref": "Permission" // }, @@ -9785,7 +9857,7 @@ func (c *PermissionsListCall) SupportsAllDrives(supportsAllDrives bool) *Permiss } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsListCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsListCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -9849,7 +9921,7 @@ func (c *PermissionsListCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/permissions") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/permissions") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -9901,6 +9973,7 @@ func (c *PermissionsListCall) Do(opts ...googleapi.CallOption) (*PermissionList, return ret, nil // { // "description": "Lists a file's or shared drive's permissions.", + // "flatPath": "drive/v3/files/{fileId}/permissions", // "httpMethod": "GET", // "id": "drive.permissions.list", // "parameterOrder": [ @@ -9939,7 +10012,7 @@ func (c *PermissionsListCall) Do(opts ...googleapi.CallOption) (*PermissionList, // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -9950,7 +10023,7 @@ func (c *PermissionsListCall) Do(opts ...googleapi.CallOption) (*PermissionList, // "type": "boolean" // } // }, - // "path": "files/{fileId}/permissions", + // "path": "drive/v3/files/{fileId}/permissions", // "response": { // "$ref": "PermissionList" // }, @@ -9999,7 +10072,9 @@ type PermissionsUpdateCall struct { header_ http.Header } -// Update: Updates a permission with patch semantics. +// Update: Updates a permission with patch semantics. **Warning:** +// Concurrent permissions operations on the same file are not supported; +// only the last update is applied. // // - fileId: The ID of the file or shared drive. // - permissionId: The ID of the permission. @@ -10027,7 +10102,7 @@ func (c *PermissionsUpdateCall) SupportsAllDrives(supportsAllDrives bool) *Permi } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsUpdateCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsUpdateCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -10036,12 +10111,7 @@ func (c *PermissionsUpdateCall) SupportsTeamDrives(supportsTeamDrives bool) *Per // TransferOwnership sets the optional parameter "transferOwnership": // 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. File owners can only transfer -// ownership of files existing on My Drive. Files existing in a shared -// drive are owned by the organization that owns that shared drive. -// Ownership transfers are not supported for files and folders in shared -// drives. Organizers of a shared drive can move items from that shared -// drive into their My Drive which transfers the ownership to them. +// acknowledgement of the side effect. func (c *PermissionsUpdateCall) TransferOwnership(transferOwnership bool) *PermissionsUpdateCall { c.urlParams_.Set("transferOwnership", fmt.Sprint(transferOwnership)) return c @@ -10097,7 +10167,7 @@ func (c *PermissionsUpdateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/permissions/{permissionId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/permissions/{permissionId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("PATCH", urls, body) if err != nil { @@ -10149,7 +10219,8 @@ func (c *PermissionsUpdateCall) Do(opts ...googleapi.CallOption) (*Permission, e } return ret, nil // { - // "description": "Updates a permission with patch semantics.", + // "description": "Updates a permission with patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + // "flatPath": "drive/v3/files/{fileId}/permissions/{permissionId}", // "httpMethod": "PATCH", // "id": "drive.permissions.update", // "parameterOrder": [ @@ -10183,13 +10254,13 @@ func (c *PermissionsUpdateCall) Do(opts ...googleapi.CallOption) (*Permission, e // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "transferOwnership": { // "default": "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. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.", + // "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.", // "location": "query", // "type": "boolean" // }, @@ -10200,7 +10271,7 @@ func (c *PermissionsUpdateCall) Do(opts ...googleapi.CallOption) (*Permission, e // "type": "boolean" // } // }, - // "path": "files/{fileId}/permissions/{permissionId}", + // "path": "drive/v3/files/{fileId}/permissions/{permissionId}", // "request": { // "$ref": "Permission" // }, @@ -10279,7 +10350,7 @@ func (c *RepliesCreateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/comments/{commentId}/replies") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/comments/{commentId}/replies") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("POST", urls, body) if err != nil { @@ -10332,6 +10403,7 @@ func (c *RepliesCreateCall) Do(opts ...googleapi.CallOption) (*Reply, error) { return ret, nil // { // "description": "Creates a reply to a comment.", + // "flatPath": "drive/v3/files/{fileId}/comments/{commentId}/replies", // "httpMethod": "POST", // "id": "drive.replies.create", // "parameterOrder": [ @@ -10352,7 +10424,7 @@ func (c *RepliesCreateCall) Do(opts ...googleapi.CallOption) (*Reply, error) { // "type": "string" // } // }, - // "path": "files/{fileId}/comments/{commentId}/replies", + // "path": "drive/v3/files/{fileId}/comments/{commentId}/replies", // "request": { // "$ref": "Reply" // }, @@ -10427,7 +10499,7 @@ func (c *RepliesDeleteCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/comments/{commentId}/replies/{replyId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("DELETE", urls, body) if err != nil { @@ -10456,6 +10528,7 @@ func (c *RepliesDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Deletes a reply.", + // "flatPath": "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}", // "httpMethod": "DELETE", // "id": "drive.replies.delete", // "parameterOrder": [ @@ -10483,7 +10556,7 @@ func (c *RepliesDeleteCall) Do(opts ...googleapi.CallOption) error { // "type": "string" // } // }, - // "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", + // "path": "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}", // "scopes": [ // "https://www.googleapis.com/auth/drive", // "https://www.googleapis.com/auth/drive.file" @@ -10574,7 +10647,7 @@ func (c *RepliesGetCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/comments/{commentId}/replies/{replyId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -10628,6 +10701,7 @@ func (c *RepliesGetCall) Do(opts ...googleapi.CallOption) (*Reply, error) { return ret, nil // { // "description": "Gets a reply by ID.", + // "flatPath": "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}", // "httpMethod": "GET", // "id": "drive.replies.get", // "parameterOrder": [ @@ -10661,7 +10735,7 @@ func (c *RepliesGetCall) Do(opts ...googleapi.CallOption) (*Reply, error) { // "type": "string" // } // }, - // "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", + // "path": "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}", // "response": { // "$ref": "Reply" // }, @@ -10768,7 +10842,7 @@ func (c *RepliesListCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/comments/{commentId}/replies") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/comments/{commentId}/replies") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -10821,6 +10895,7 @@ func (c *RepliesListCall) Do(opts ...googleapi.CallOption) (*ReplyList, error) { return ret, nil // { // "description": "Lists a comment's replies.", + // "flatPath": "drive/v3/files/{fileId}/comments/{commentId}/replies", // "httpMethod": "GET", // "id": "drive.replies.list", // "parameterOrder": [ @@ -10861,7 +10936,7 @@ func (c *RepliesListCall) Do(opts ...googleapi.CallOption) (*ReplyList, error) { // "type": "string" // } // }, - // "path": "files/{fileId}/comments/{commentId}/replies", + // "path": "drive/v3/files/{fileId}/comments/{commentId}/replies", // "response": { // "$ref": "ReplyList" // }, @@ -10962,7 +11037,7 @@ func (c *RepliesUpdateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/comments/{commentId}/replies/{replyId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("PATCH", urls, body) if err != nil { @@ -11016,6 +11091,7 @@ func (c *RepliesUpdateCall) Do(opts ...googleapi.CallOption) (*Reply, error) { return ret, nil // { // "description": "Updates a reply with patch semantics.", + // "flatPath": "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}", // "httpMethod": "PATCH", // "id": "drive.replies.update", // "parameterOrder": [ @@ -11043,7 +11119,7 @@ func (c *RepliesUpdateCall) Do(opts ...googleapi.CallOption) (*Reply, error) { // "type": "string" // } // }, - // "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", + // "path": "drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}", // "request": { // "$ref": "Reply" // }, @@ -11118,7 +11194,7 @@ func (c *RevisionsDeleteCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/revisions/{revisionId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/revisions/{revisionId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("DELETE", urls, body) if err != nil { @@ -11146,6 +11222,7 @@ func (c *RevisionsDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "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.", + // "flatPath": "drive/v3/files/{fileId}/revisions/{revisionId}", // "httpMethod": "DELETE", // "id": "drive.revisions.delete", // "parameterOrder": [ @@ -11166,7 +11243,7 @@ func (c *RevisionsDeleteCall) Do(opts ...googleapi.CallOption) error { // "type": "string" // } // }, - // "path": "files/{fileId}/revisions/{revisionId}", + // "path": "drive/v3/files/{fileId}/revisions/{revisionId}", // "scopes": [ // "https://www.googleapis.com/auth/drive", // "https://www.googleapis.com/auth/drive.appdata", @@ -11256,7 +11333,7 @@ func (c *RevisionsGetCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/revisions/{revisionId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/revisions/{revisionId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -11325,6 +11402,7 @@ func (c *RevisionsGetCall) Do(opts ...googleapi.CallOption) (*Revision, error) { return ret, nil // { // "description": "Gets a revision's metadata or content by ID.", + // "flatPath": "drive/v3/files/{fileId}/revisions/{revisionId}", // "httpMethod": "GET", // "id": "drive.revisions.get", // "parameterOrder": [ @@ -11351,7 +11429,7 @@ func (c *RevisionsGetCall) Do(opts ...googleapi.CallOption) (*Revision, error) { // "type": "string" // } // }, - // "path": "files/{fileId}/revisions/{revisionId}", + // "path": "drive/v3/files/{fileId}/revisions/{revisionId}", // "response": { // "$ref": "Revision" // }, @@ -11453,7 +11531,7 @@ func (c *RevisionsListCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/revisions") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/revisions") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -11505,6 +11583,7 @@ func (c *RevisionsListCall) Do(opts ...googleapi.CallOption) (*RevisionList, err return ret, nil // { // "description": "Lists a file's revisions.", + // "flatPath": "drive/v3/files/{fileId}/revisions", // "httpMethod": "GET", // "id": "drive.revisions.list", // "parameterOrder": [ @@ -11532,7 +11611,7 @@ func (c *RevisionsListCall) Do(opts ...googleapi.CallOption) (*RevisionList, err // "type": "string" // } // }, - // "path": "files/{fileId}/revisions", + // "path": "drive/v3/files/{fileId}/revisions", // "response": { // "$ref": "RevisionList" // }, @@ -11634,7 +11713,7 @@ func (c *RevisionsUpdateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "files/{fileId}/revisions/{revisionId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/files/{fileId}/revisions/{revisionId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("PATCH", urls, body) if err != nil { @@ -11687,6 +11766,7 @@ func (c *RevisionsUpdateCall) Do(opts ...googleapi.CallOption) (*Revision, error return ret, nil // { // "description": "Updates a revision with patch semantics.", + // "flatPath": "drive/v3/files/{fileId}/revisions/{revisionId}", // "httpMethod": "PATCH", // "id": "drive.revisions.update", // "parameterOrder": [ @@ -11707,7 +11787,7 @@ func (c *RevisionsUpdateCall) Do(opts ...googleapi.CallOption) (*Revision, error // "type": "string" // } // }, - // "path": "files/{fileId}/revisions/{revisionId}", + // "path": "drive/v3/files/{fileId}/revisions/{revisionId}", // "request": { // "$ref": "Revision" // }, @@ -11733,7 +11813,7 @@ type TeamdrivesCreateCall struct { header_ http.Header } -// Create: Deprecated use drives.create instead. +// Create: Deprecated: Use `drives.create` instead. // // - requestId: An ID, such as a random UUID, which uniquely identifies // this user's request for idempotent creation of a Team Drive. A @@ -11788,7 +11868,7 @@ func (c *TeamdrivesCreateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "teamdrives") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/teamdrives") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("POST", urls, body) if err != nil { @@ -11836,7 +11916,8 @@ func (c *TeamdrivesCreateCall) Do(opts ...googleapi.CallOption) (*TeamDrive, err } return ret, nil // { - // "description": "Deprecated use drives.create instead.", + // "description": "Deprecated: Use `drives.create` instead.", + // "flatPath": "drive/v3/teamdrives", // "httpMethod": "POST", // "id": "drive.teamdrives.create", // "parameterOrder": [ @@ -11850,7 +11931,7 @@ func (c *TeamdrivesCreateCall) Do(opts ...googleapi.CallOption) (*TeamDrive, err // "type": "string" // } // }, - // "path": "teamdrives", + // "path": "drive/v3/teamdrives", // "request": { // "$ref": "TeamDrive" // }, @@ -11874,7 +11955,7 @@ type TeamdrivesDeleteCall struct { header_ http.Header } -// Delete: Deprecated use drives.delete instead. +// Delete: Deprecated: Use `drives.delete` instead. // // - teamDriveId: The ID of the Team Drive. func (r *TeamdrivesService) Delete(teamDriveId string) *TeamdrivesDeleteCall { @@ -11918,7 +11999,7 @@ func (c *TeamdrivesDeleteCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "teamdrives/{teamDriveId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/teamdrives/{teamDriveId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("DELETE", urls, body) if err != nil { @@ -11944,7 +12025,8 @@ func (c *TeamdrivesDeleteCall) Do(opts ...googleapi.CallOption) error { } return nil // { - // "description": "Deprecated use drives.delete instead.", + // "description": "Deprecated: Use `drives.delete` instead.", + // "flatPath": "drive/v3/teamdrives/{teamDriveId}", // "httpMethod": "DELETE", // "id": "drive.teamdrives.delete", // "parameterOrder": [ @@ -11958,7 +12040,7 @@ func (c *TeamdrivesDeleteCall) Do(opts ...googleapi.CallOption) error { // "type": "string" // } // }, - // "path": "teamdrives/{teamDriveId}", + // "path": "drive/v3/teamdrives/{teamDriveId}", // "scopes": [ // "https://www.googleapis.com/auth/drive" // ] @@ -11977,7 +12059,7 @@ type TeamdrivesGetCall struct { header_ http.Header } -// Get: Deprecated use drives.get instead. +// Get: Deprecated: Use `drives.get` instead. // // - teamDriveId: The ID of the Team Drive. func (r *TeamdrivesService) Get(teamDriveId string) *TeamdrivesGetCall { @@ -12043,7 +12125,7 @@ func (c *TeamdrivesGetCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "teamdrives/{teamDriveId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/teamdrives/{teamDriveId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -12094,7 +12176,8 @@ func (c *TeamdrivesGetCall) Do(opts ...googleapi.CallOption) (*TeamDrive, error) } return ret, nil // { - // "description": "Deprecated use drives.get instead.", + // "description": "Deprecated: Use `drives.get` instead.", + // "flatPath": "drive/v3/teamdrives/{teamDriveId}", // "httpMethod": "GET", // "id": "drive.teamdrives.get", // "parameterOrder": [ @@ -12114,7 +12197,7 @@ func (c *TeamdrivesGetCall) Do(opts ...googleapi.CallOption) (*TeamDrive, error) // "type": "boolean" // } // }, - // "path": "teamdrives/{teamDriveId}", + // "path": "drive/v3/teamdrives/{teamDriveId}", // "response": { // "$ref": "TeamDrive" // }, @@ -12136,7 +12219,7 @@ type TeamdrivesListCall struct { header_ http.Header } -// List: Deprecated use drives.list instead. +// List: Deprecated: Use `drives.list` instead. func (r *TeamdrivesService) List() *TeamdrivesListCall { c := &TeamdrivesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} return c @@ -12220,7 +12303,7 @@ func (c *TeamdrivesListCall) doRequest(alt string) (*http.Response, error) { var body io.Reader = nil c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "teamdrives") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/teamdrives") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, body) if err != nil { @@ -12268,9 +12351,11 @@ func (c *TeamdrivesListCall) Do(opts ...googleapi.CallOption) (*TeamDriveList, e } return ret, nil // { - // "description": "Deprecated use drives.list instead.", + // "description": "Deprecated: Use `drives.list` instead.", + // "flatPath": "drive/v3/teamdrives", // "httpMethod": "GET", // "id": "drive.teamdrives.list", + // "parameterOrder": [], // "parameters": { // "pageSize": { // "default": "10", @@ -12298,7 +12383,7 @@ func (c *TeamdrivesListCall) Do(opts ...googleapi.CallOption) (*TeamDriveList, e // "type": "boolean" // } // }, - // "path": "teamdrives", + // "path": "drive/v3/teamdrives", // "response": { // "$ref": "TeamDriveList" // }, @@ -12342,7 +12427,7 @@ type TeamdrivesUpdateCall struct { header_ http.Header } -// Update: Deprecated use drives.update instead +// Update: Deprecated: Use `drives.update` instead. // // - teamDriveId: The ID of the Team Drive. func (r *TeamdrivesService) Update(teamDriveId string, teamdrive *TeamDrive) *TeamdrivesUpdateCall { @@ -12401,7 +12486,7 @@ func (c *TeamdrivesUpdateCall) doRequest(alt string) (*http.Response, error) { reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "teamdrives/{teamDriveId}") + urls := googleapi.ResolveRelative(c.s.BasePath, "drive/v3/teamdrives/{teamDriveId}") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("PATCH", urls, body) if err != nil { @@ -12452,7 +12537,8 @@ func (c *TeamdrivesUpdateCall) Do(opts ...googleapi.CallOption) (*TeamDrive, err } return ret, nil // { - // "description": "Deprecated use drives.update instead", + // "description": "Deprecated: Use `drives.update` instead.", + // "flatPath": "drive/v3/teamdrives/{teamDriveId}", // "httpMethod": "PATCH", // "id": "drive.teamdrives.update", // "parameterOrder": [ @@ -12472,7 +12558,7 @@ func (c *TeamdrivesUpdateCall) Do(opts ...googleapi.CallOption) (*TeamDrive, err // "type": "boolean" // } // }, - // "path": "teamdrives/{teamDriveId}", + // "path": "drive/v3/teamdrives/{teamDriveId}", // "request": { // "$ref": "TeamDrive" // }, diff --git a/paymentsresellersubscription/v1/paymentsresellersubscription-api.json b/paymentsresellersubscription/v1/paymentsresellersubscription-api.json index b27860fdaf3..6f27de1f7d3 100644 --- a/paymentsresellersubscription/v1/paymentsresellersubscription-api.json +++ b/paymentsresellersubscription/v1/paymentsresellersubscription-api.json @@ -396,7 +396,7 @@ } } }, - "revision": "20230507", + "revision": "20230517", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1Amount": { @@ -744,7 +744,7 @@ "properties": { "googleOnePayload": { "$ref": "GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload", - "description": "Payload specific to Google One products." + "description": "Product-specific payloads. Payload specific to Google One products." }, "youtubePayload": { "$ref": "GoogleCloudPaymentsResellerSubscriptionV1YoutubePayload", diff --git a/paymentsresellersubscription/v1/paymentsresellersubscription-gen.go b/paymentsresellersubscription/v1/paymentsresellersubscription-gen.go index de65a55050e..17bd11c1cfb 100644 --- a/paymentsresellersubscription/v1/paymentsresellersubscription-gen.go +++ b/paymentsresellersubscription/v1/paymentsresellersubscription-gen.go @@ -788,7 +788,8 @@ func (s *GoogleCloudPaymentsResellerSubscriptionV1Product) MarshalJSON() ([]byte // GoogleCloudPaymentsResellerSubscriptionV1ProductPayload: Specifies // product specific payload. type GoogleCloudPaymentsResellerSubscriptionV1ProductPayload struct { - // GoogleOnePayload: Payload specific to Google One products. + // GoogleOnePayload: Product-specific payloads. Payload specific to + // Google One products. GoogleOnePayload *GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload `json:"googleOnePayload,omitempty"` // YoutubePayload: Payload specific to Youtube products. diff --git a/retail/v2/retail-api.json b/retail/v2/retail-api.json index a6908013ba0..cfeedc3f049 100644 --- a/retail/v2/retail-api.json +++ b/retail/v2/retail-api.json @@ -2031,7 +2031,7 @@ } } }, - "revision": "20230504", + "revision": "20230516", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2427,7 +2427,7 @@ "type": "boolean" }, "indexableOption": { - "description": "When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified, otherwise throws INVALID_FORMAT error.", + "description": "When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.", "enum": [ "INDEXABLE_OPTION_UNSPECIFIED", "INDEXABLE_ENABLED", @@ -2459,7 +2459,7 @@ "type": "string" }, "searchableOption": { - "description": "When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes. Must be specified, otherwise throws INVALID_FORMAT error.", + "description": "When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes. Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.", "enum": [ "SEARCHABLE_OPTION_UNSPECIFIED", "SEARCHABLE_ENABLED", diff --git a/retail/v2/retail-gen.go b/retail/v2/retail-gen.go index 513f742d60a..e8bbf32d8ff 100644 --- a/retail/v2/retail-gen.go +++ b/retail/v2/retail-gen.go @@ -1081,8 +1081,10 @@ type GoogleCloudRetailV2CatalogAttribute struct { // IndexableOption: When AttributesConfig.attribute_config_level is // CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values // are indexed so that it can be filtered, faceted, or boosted in - // SearchService.Search. Must be specified, otherwise throws - // INVALID_FORMAT error. + // SearchService.Search. Must be specified when + // AttributesConfig.attribute_config_level is + // CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT + // error. // // Possible values: // "INDEXABLE_OPTION_UNSPECIFIED" - Value used when unset. @@ -1119,7 +1121,9 @@ type GoogleCloudRetailV2CatalogAttribute struct { // SEARCHABLE_ENABLED but attribute type is numerical, attribute values // will not be searchable by text queries in SearchService.Search, as // there are no text values associated to numerical attributes. Must be - // specified, otherwise throws INVALID_FORMAT error. + // specified, when AttributesConfig.attribute_config_level is + // CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT + // error. // // Possible values: // "SEARCHABLE_OPTION_UNSPECIFIED" - Value used when unset. diff --git a/retail/v2alpha/retail-api.json b/retail/v2alpha/retail-api.json index eb38ede72a4..4bb1a08996b 100644 --- a/retail/v2alpha/retail-api.json +++ b/retail/v2alpha/retail-api.json @@ -2217,7 +2217,7 @@ } } }, - "revision": "20230504", + "revision": "20230516", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3088,7 +3088,7 @@ "type": "boolean" }, "indexableOption": { - "description": "When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified, otherwise throws INVALID_FORMAT error.", + "description": "When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.", "enum": [ "INDEXABLE_OPTION_UNSPECIFIED", "INDEXABLE_ENABLED", @@ -3134,7 +3134,7 @@ "type": "string" }, "searchableOption": { - "description": "When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes. Must be specified, otherwise throws INVALID_FORMAT error.", + "description": "When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes. Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.", "enum": [ "SEARCHABLE_OPTION_UNSPECIFIED", "SEARCHABLE_ENABLED", diff --git a/retail/v2alpha/retail-gen.go b/retail/v2alpha/retail-gen.go index 7cd59bed0d1..c7ad7a42bd8 100644 --- a/retail/v2alpha/retail-gen.go +++ b/retail/v2alpha/retail-gen.go @@ -1950,8 +1950,10 @@ type GoogleCloudRetailV2alphaCatalogAttribute struct { // IndexableOption: When AttributesConfig.attribute_config_level is // CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values // are indexed so that it can be filtered, faceted, or boosted in - // SearchService.Search. Must be specified, otherwise throws - // INVALID_FORMAT error. + // SearchService.Search. Must be specified when + // AttributesConfig.attribute_config_level is + // CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT + // error. // // Possible values: // "INDEXABLE_OPTION_UNSPECIFIED" - Value used when unset. @@ -2005,7 +2007,9 @@ type GoogleCloudRetailV2alphaCatalogAttribute struct { // SEARCHABLE_ENABLED but attribute type is numerical, attribute values // will not be searchable by text queries in SearchService.Search, as // there are no text values associated to numerical attributes. Must be - // specified, otherwise throws INVALID_FORMAT error. + // specified, when AttributesConfig.attribute_config_level is + // CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT + // error. // // Possible values: // "SEARCHABLE_OPTION_UNSPECIFIED" - Value used when unset. diff --git a/retail/v2beta/retail-api.json b/retail/v2beta/retail-api.json index 1cf2d262e5c..9acb0020b73 100644 --- a/retail/v2beta/retail-api.json +++ b/retail/v2beta/retail-api.json @@ -2059,7 +2059,7 @@ } } }, - "revision": "20230504", + "revision": "20230516", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3706,7 +3706,7 @@ "type": "boolean" }, "indexableOption": { - "description": "When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified, otherwise throws INVALID_FORMAT error.", + "description": "When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.", "enum": [ "INDEXABLE_OPTION_UNSPECIFIED", "INDEXABLE_ENABLED", @@ -3752,7 +3752,7 @@ "type": "string" }, "searchableOption": { - "description": "When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes. Must be specified, otherwise throws INVALID_FORMAT error.", + "description": "When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes. Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.", "enum": [ "SEARCHABLE_OPTION_UNSPECIFIED", "SEARCHABLE_ENABLED", diff --git a/retail/v2beta/retail-gen.go b/retail/v2beta/retail-gen.go index 0028e39bb15..aeea577f69b 100644 --- a/retail/v2beta/retail-gen.go +++ b/retail/v2beta/retail-gen.go @@ -3323,8 +3323,10 @@ type GoogleCloudRetailV2betaCatalogAttribute struct { // IndexableOption: When AttributesConfig.attribute_config_level is // CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values // are indexed so that it can be filtered, faceted, or boosted in - // SearchService.Search. Must be specified, otherwise throws - // INVALID_FORMAT error. + // SearchService.Search. Must be specified when + // AttributesConfig.attribute_config_level is + // CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT + // error. // // Possible values: // "INDEXABLE_OPTION_UNSPECIFIED" - Value used when unset. @@ -3378,7 +3380,9 @@ type GoogleCloudRetailV2betaCatalogAttribute struct { // SEARCHABLE_ENABLED but attribute type is numerical, attribute values // will not be searchable by text queries in SearchService.Search, as // there are no text values associated to numerical attributes. Must be - // specified, otherwise throws INVALID_FORMAT error. + // specified, when AttributesConfig.attribute_config_level is + // CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT + // error. // // Possible values: // "SEARCHABLE_OPTION_UNSPECIFIED" - Value used when unset.