openapi: 3.1.0 info: title: Google Drive Labels API description: An API for managing Drive Labels version: v2 contact: name: Google url: https://google.com x-twitter: youtube license: name: Creative Commons Attribution 3.0 url: http://creativecommons.org/licenses/by/3.0/ termsOfService: https://developers.google.com/terms/ servers: - url: https://drivelabels.googleapis.com description: Google Drive Labels API Server tags: - name: Labels description: Operations related to Labels - name: Limits description: Operations related to Limits - name: Users description: Operations related to Users externalDocs: url: https://developers.google.com/drive/labels paths: /v2/labels: get: tags: - Labels summary: Google Retrieve Labels description: List labels. operationId: googleDrivelabelsLabelsList security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels.readonly Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels.readonly - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels.readonly Oauth2c: - https://www.googleapis.com/auth/drive.labels.readonly parameters: - description: 'The customer to scope this list request to. For example: "customers/abcd1234". If unset, will return all labels within the current customer.' in: query name: customer schema: type: string - description: The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language are used. in: query name: languageCode schema: type: string - description: Specifies the level of access the user must have on the returned Labels. The minimum role a user must have on a label. Defaults to `READER`. in: query name: minimumRole schema: enum: - LABEL_ROLE_UNSPECIFIED - READER - APPLIER - ORGANIZER - EDITOR type: string - description: 'Maximum number of labels to return per page. Default: 50. Max: 200.' in: query name: pageSize schema: type: integer - description: The token of the page to return. in: query name: pageToken schema: type: string - description: Whether to include only published labels in the results. * When `true`, only the current published label revisions are returned. Disabled labels are included. Returned label resource names reference the published revision (`labels/{id}/{revision_id}`). * When `false`, the current label revisions are returned, which might not be published. Returned label resource names don't reference a specific revision (`labels/{id}`). in: query name: publishedOnly schema: type: boolean - description: Set to `true` in order to use the user's admin credentials. This will return all Labels within the customer. in: query name: useAdminAccess schema: type: boolean - description: When specified, only certain fields belonging to the indicated view are returned. in: query name: view schema: enum: - LABEL_VIEW_BASIC - LABEL_VIEW_FULL type: string - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2ListLabelsResponse' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample post: tags: - Labels summary: Google Create Labels description: Creates a new Label. operationId: googleDrivelabelsLabelsCreate security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels parameters: - description: The BCP-47 language code to use for evaluating localized Field labels in response. When not specified, values in the default configured language will be used. in: query name: languageCode schema: type: string - description: Set to `true` in order to use the user's admin privileges. The server will verify the user is an admin before allowing access. in: query name: useAdminAccess schema: type: boolean - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample /v2/limits/label: get: tags: - Limits summary: Google Retrieve Limits Label description: Get the constraints on the structure of a Label; such as, the maximum number of Fields allowed and maximum length of the label title. operationId: googleDrivelabelsLimitsGetlabel security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels.readonly Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels.readonly - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels.readonly Oauth2c: - https://www.googleapis.com/auth/drive.labels.readonly parameters: - description: 'Required. Label revision resource name Must be: "limits/label"' in: query name: name schema: type: string - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelLimits' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample /v2/{name}: get: tags: - Users summary: Google Retrieve Name description: Gets the user capabilities. operationId: googleDrivelabelsUsersGetcapabilities security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels.readonly Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels.readonly - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels.readonly Oauth2c: - https://www.googleapis.com/auth/drive.labels.readonly parameters: - description: Required. The resource name of the user. Only "users/me/capabilities" is supported. in: path name: name required: true schema: type: string - description: 'The customer to scope this request to. For example: "customers/abcd1234". If unset, will return settings within the current customer.' in: query name: customer schema: type: string - description: Set to `true` in order to use the user's admin credentials. The server verifies that the user is an admin for the label before allowing access. in: query name: useAdminAccess schema: type: boolean - description: When specified, only certain fields belonging to the indicated view are returned. in: query name: view schema: enum: - LABEL_VIEW_BASIC - LABEL_VIEW_FULL type: string - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserCapabilities' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample delete: tags: - Labels summary: Google Delete Name description: Deletes a Label's permission. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing. operationId: googleDrivelabelsLabelsRevisionsPermissionsDelete security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels parameters: - description: Required. Label Permission resource name. in: path name: name required: true schema: type: string - description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. in: query name: useAdminAccess schema: type: boolean - description: The revision_id of the label that the write request will be applied to. If this is not the latest revision of the label, the request will not be processed and will return a 400 Bad Request error. in: query name: writeControl.requiredRevisionId schema: type: string - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleProtobufEmpty' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample /v2/{name}:delta: post: tags: - Labels summary: Google Create Name:delta description: 'Updates a single Label by applying a set of update requests resulting in a new draft revision. The batch update is all-or-nothing: If any of the update requests are invalid, no changes are applied. The resulting draft revision must be published before the changes may be used with Drive Items.' operationId: googleDrivelabelsLabelsDelta security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels parameters: - description: Required. The resource name of the Label to update. in: path name: name required: true schema: type: string - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample /v2/{name}:disable: post: tags: - Labels summary: Google Create Name:disable description: Disable a published Label. Disabling a Label will result in a new disabled published revision based on the current published revision. If there is a draft revision, a new disabled draft revision will be created based on the latest draft revision. Older draft revisions will be deleted. Once disabled, a label may be deleted with `DeleteLabel`. operationId: googleDrivelabelsLabelsDisable security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels parameters: - description: Required. Label resource name. in: path name: name required: true schema: type: string - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DisableLabelRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample /v2/{name}:enable: post: tags: - Labels summary: Google Create Name:enable description: Enable a disabled Label and restore it to its published state. This will result in a new published revision based on the current disabled published revision. If there is an existing disabled draft revision, a new revision will be created based on that draft and will be enabled. operationId: googleDrivelabelsLabelsEnable security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels parameters: - description: Required. Label resource name. in: path name: name required: true schema: type: string - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2EnableLabelRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample /v2/{name}:publish: post: tags: - Labels summary: Google Create Name:publish description: 'Publish all draft changes to the Label. Once published, the Label may not return to its draft state. See `google.apps.drive.labels.v2.Lifecycle` for more information. Publishing a Label will result in a new published revision. All previous draft revisions will be deleted. Previous published revisions will be kept but are subject to automated deletion as needed. Once published, some changes are no longer permitted. Generally, any change that would invalidate or cause new restrictions on existing metadata related to the Label will be rejected. For example, the following changes to a Label will be rejected after the Label is published: * The label cannot be directly deleted. It must be disabled first, then deleted. * Field.FieldType cannot be changed. * Changes to Field validation options cannot reject something that was previously accepted. * Reducing the max entries.' operationId: googleDrivelabelsLabelsPublish security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels parameters: - description: Required. Label resource name. in: path name: name required: true schema: type: string - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2PublishLabelRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample /v2/{name}:updateLabelCopyMode: post: tags: - Labels summary: Google Create Name:updatelabelcopymode description: Updates a Label's `CopyMode`. Changes to this policy are not revisioned, do not require publishing, and take effect immediately. operationId: googleDrivelabelsLabelsUpdatelabelcopymode security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels parameters: - description: Required. The resource name of the Label to update. in: path name: name required: true schema: type: string - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UpdateLabelCopyModeRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample /v2/{parent}/locks: get: tags: - Labels summary: Google Retrieve Parent Locks description: Lists the LabelLocks on a Label. operationId: googleDrivelabelsLabelsRevisionsLocksList security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels.readonly Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels.readonly - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels.readonly Oauth2c: - https://www.googleapis.com/auth/drive.labels.readonly parameters: - description: 'Required. Label on which Locks are applied. Format: labels/{label}' in: path name: parent required: true schema: type: string - description: 'Maximum number of Locks to return per page. Default: 100. Max: 200.' in: query name: pageSize schema: type: integer - description: The token of the page to return. in: query name: pageToken schema: type: string - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2ListLabelLocksResponse' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample /v2/{parent}/permissions: get: tags: - Labels summary: Google Retrieve Parent Permissions description: Lists a Label's permissions. operationId: googleDrivelabelsLabelsRevisionsPermissionsList security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels.readonly Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels.readonly - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels.readonly Oauth2c: - https://www.googleapis.com/auth/drive.labels.readonly parameters: - description: 'Required. The parent Label resource name on which Label Permission are listed. Format: labels/{label}' in: path name: parent required: true schema: type: string - description: 'Maximum number of permissions to return per page. Default: 50. Max: 200.' in: query name: pageSize schema: type: integer - description: The token of the page to return. in: query name: pageToken schema: type: string - description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. in: query name: useAdminAccess schema: type: boolean - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2ListLabelPermissionsResponse' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample post: tags: - Labels summary: Google Create Parent Permissions description: Updates a Label's permissions. If a permission for the indicated principal doesn't exist, a new Label Permission is created, otherwise the existing permission is updated. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing. operationId: googleDrivelabelsLabelsRevisionsPermissionsCreate security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels parameters: - description: 'Required. The parent Label resource name on the Label Permission is created. Format: labels/{label}' in: path name: parent required: true schema: type: string - description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. in: query name: useAdminAccess schema: type: boolean - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample patch: tags: - Labels summary: Google Patch Parent Permissions description: Updates a Label's permissions. If a permission for the indicated principal doesn't exist, a new Label Permission is created, otherwise the existing permission is updated. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing. operationId: googleDrivelabelsLabelsRevisionsUpdatepermissions security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels parameters: - description: Required. The parent Label resource name. in: path name: parent required: true schema: type: string - description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. in: query name: useAdminAccess schema: type: boolean - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample /v2/{parent}/permissions:batchDelete: post: tags: - Labels summary: Google Create Parent Permissions:batchdelete description: Deletes Label permissions. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing. operationId: googleDrivelabelsLabelsRevisionsPermissionsBatchdelete security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels parameters: - description: 'Required. The parent Label resource name shared by all permissions being deleted. Format: labels/{label} If this is set, the parent field in the UpdateLabelPermissionRequest messages must either be empty or match this field.' in: path name: parent required: true schema: type: string - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleProtobufEmpty' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample /v2/{parent}/permissions:batchUpdate: post: tags: - Labels summary: Google Create Parent Permissions:batchupdate description: Updates Label permissions. If a permission for the indicated principal doesn't exist, a new Label Permission is created, otherwise the existing permission is updated. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing. operationId: googleDrivelabelsLabelsRevisionsPermissionsBatchupdate security: - Oauth2: - https://www.googleapis.com/auth/drive.admin.labels Oauth2c: - https://www.googleapis.com/auth/drive.admin.labels - Oauth2: - https://www.googleapis.com/auth/drive.labels Oauth2c: - https://www.googleapis.com/auth/drive.labels parameters: - description: 'Required. The parent Label resource name shared by all permissions being updated. Format: labels/{label} If this is set, the parent field in the UpdateLabelPermissionRequest messages must either be empty or match this field.' in: path name: parent required: true schema: type: string - description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string - description: OAuth access token. in: query name: access_token schema: type: string - description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string - description: JSONP in: query name: callback schema: type: string - description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string - description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string - description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - in: header name: Authorization schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: SuccessExample components: schemas: GoogleAppsDriveLabelsV2BadgeColors: description: The color derived from BadgeConfig and changed to the closest recommended supported color. properties: backgroundColor: $ref: '#/components/schemas/GoogleTypeColor' description: Output only. Badge background that pairs with the foreground. readOnly: true foregroundColor: $ref: '#/components/schemas/GoogleTypeColor' description: Output only. Badge foreground that pairs with the background. readOnly: true soloColor: $ref: '#/components/schemas/GoogleTypeColor' description: Output only. Color that can be used for text without a background. readOnly: true type: object GoogleAppsDriveLabelsV2BadgeConfig: description: Badge status of the label. properties: color: $ref: '#/components/schemas/GoogleTypeColor' description: The color of the badge. When not specified, no badge is rendered. The background, foreground, and solo (light and dark mode) colors set here are changed in the Drive UI into the closest recommended supported color. priorityOverride: description: Override the default global priority of this badge. When set to 0, the default priority heuristic is used. format: int64 type: string type: object GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest: description: Deletes one of more Label Permissions. properties: requests: description: Required. The request message specifying the resources to update. items: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeleteLabelPermissionRequest' type: array useAdminAccess: description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. If this is set, the use_admin_access field in the DeleteLabelPermissionRequest messages must either be empty or match this field. type: boolean type: object GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest: description: Updates one or more Label Permissions. properties: requests: description: Required. The request message specifying the resources to update. items: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UpdateLabelPermissionRequest' type: array useAdminAccess: description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. If this is set, the use_admin_access field in the UpdateLabelPermissionRequest messages must either be empty or match this field. type: boolean type: object GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse: description: Response for updating one or more Label Permissions. properties: permissions: description: Required. Permissions updated. items: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' type: array type: object GoogleAppsDriveLabelsV2DateLimits: description: Limits for date Field type. properties: maxValue: $ref: '#/components/schemas/GoogleTypeDate' description: Maximum value for the date Field type. minValue: $ref: '#/components/schemas/GoogleTypeDate' description: Minimum value for the date Field type. type: object GoogleAppsDriveLabelsV2DeleteLabelPermissionRequest: description: Deletes a Label Permission. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing. properties: name: description: Required. Label Permission resource name. type: string useAdminAccess: description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. type: boolean type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest: description: The set of requests for updating aspects of a Label. If any request is not valid, no requests will be applied. properties: languageCode: description: The BCP-47 language code to use for evaluating localized Field labels when `include_label_in_response` is `true`. type: string requests: description: A list of updates to apply to the Label. Requests will be applied in the order they are specified. items: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestRequest' type: array useAdminAccess: description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. type: boolean view: description: When specified, only certain fields belonging to the indicated view will be returned. enum: - LABEL_VIEW_BASIC - LABEL_VIEW_FULL type: string writeControl: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2WriteControl' description: Provides control over how write requests are executed. type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateFieldRequest: description: Request to create a Field within a Label. properties: field: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Field' description: Required. Field to create. type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateSelectionChoiceRequest: description: Request to create a Selection Choice. properties: choice: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice' description: Required. The Choice to create. fieldId: description: Required. The Selection Field in which a Choice will be created. type: string type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteFieldRequest: description: Request to delete the Field. properties: id: description: Required. ID of the Field to delete. type: string type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteSelectionChoiceRequest: description: Request to delete a Choice. properties: fieldId: description: Required. The Selection Field from which a Choice will be deleted. type: string id: description: Required. Choice to delete. type: string type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableFieldRequest: description: Request to disable the Field. properties: disabledPolicy: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LifecycleDisabledPolicy' description: Required. Field Disabled Policy. id: description: Required. Key of the Field to disable. type: string updateMask: description: The fields that should be updated. At least one field must be specified. The root `disabled_policy` is implied and should not be specified. A single `*` can be used as short-hand for updating every field. format: google-fieldmask type: string type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableSelectionChoiceRequest: description: Request to disable a Choice. properties: disabledPolicy: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LifecycleDisabledPolicy' description: Required. The disabled policy to update. fieldId: description: Required. The Selection Field in which a Choice will be disabled. type: string id: description: Required. Choice to disable. type: string updateMask: description: The fields that should be updated. At least one field must be specified. The root `disabled_policy` is implied and should not be specified. A single `*` can be used as short-hand for updating every field. format: google-fieldmask type: string type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableFieldRequest: description: Request to enable the Field. properties: id: description: Required. ID of the Field to enable. type: string type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableSelectionChoiceRequest: description: Request to enable a Choice. properties: fieldId: description: Required. The Selection Field in which a Choice will be enabled. type: string id: description: Required. Choice to enable. type: string type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestRequest: description: A single kind of update to apply to a Label. properties: createField: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateFieldRequest' description: Creates a new Field. createSelectionChoice: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateSelectionChoiceRequest' description: Creates Choice within a Selection field. deleteField: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteFieldRequest' description: Deletes a Field from the label. deleteSelectionChoice: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteSelectionChoiceRequest' description: Delete a Choice within a Selection Field. disableField: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableFieldRequest' description: Disables the Field. disableSelectionChoice: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableSelectionChoiceRequest' description: Disable a Choice within a Selection Field. enableField: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableFieldRequest' description: Enables the Field. enableSelectionChoice: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableSelectionChoiceRequest' description: Enable a Choice within a Selection Field. updateField: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldPropertiesRequest' description: Updates basic properties of a Field. updateFieldType: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldTypeRequest' description: Update Field type and/or type options. updateLabel: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateLabelPropertiesRequest' description: Updates the Label properties. updateSelectionChoiceProperties: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest' description: Update a Choice properties within a Selection Field. type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldPropertiesRequest: description: Request to update Field properties. properties: id: description: Required. The Field to update. type: string properties: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldProperties' description: Required. Basic Field properties. updateMask: description: The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `*` can be used as short-hand for updating every field. format: google-fieldmask type: string type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldTypeRequest: description: Request to change the type of a Field. properties: dateOptions: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldDateOptions' description: Update field to Date. id: description: Required. The Field to update. type: string integerOptions: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldIntegerOptions' description: Update field to Integer. selectionOptions: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptions' description: Update field to Selection. textOptions: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldTextOptions' description: Update field to Text. updateMask: description: The fields that should be updated. At least one field must be specified. The root of `type_options` is implied and should not be specified. A single `*` can be used as short-hand for updating every field. format: google-fieldmask type: string userOptions: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldUserOptions' description: Update field to User. type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateLabelPropertiesRequest: description: Updates basic properties of a Label. properties: properties: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelProperties' description: Required. Label properties to update. updateMask: description: The fields that should be updated. At least one field must be specified. The root `label_properties` is implied and should not be specified. A single `*` can be used as short-hand for updating every field. format: google-fieldmask type: string type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest: description: Request to update a Choice properties. properties: fieldId: description: Required. The Selection Field to update. type: string id: description: Required. The Choice to update. type: string properties: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties' description: Required. The Choice properties to update. updateMask: description: The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `*` can be used as short-hand for updating every field. format: google-fieldmask type: string type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse: description: Response for Label update. properties: responses: description: The reply of the updates. This maps 1:1 with the updates, although responses to some requests may be empty. items: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseResponse' type: array updatedLabel: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' description: The label after updates were applied. This is only set if [BatchUpdateLabelResponse2.include_label_in_response] is `true` and there were no errors. type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateFieldResponse: description: Response following Field create. properties: id: description: The field of the created field. When left blank in a create request, a key will be autogenerated and can be identified here. type: string priority: description: The priority of the created field. The priority may change from what was specified to assure contiguous priorities between fields (1-n). format: int32 type: integer type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateSelectionChoiceResponse: description: Response following Selection Choice create. properties: fieldId: description: The server-generated id of the field. type: string id: description: The server-generated ID of the created choice within the Field type: string type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteFieldResponse: description: Response following Field delete. properties: {} type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteSelectionChoiceResponse: description: Response following Choice delete. properties: {} type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableFieldResponse: description: Response following Field disable. properties: {} type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableSelectionChoiceResponse: description: Response following Choice disable. properties: {} type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableFieldResponse: description: Response following Field enable. properties: {} type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableSelectionChoiceResponse: description: Response following Choice enable. properties: {} type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseResponse: description: A single response from an update. properties: createField: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateFieldResponse' description: Creates a new Field. createSelectionChoice: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateSelectionChoiceResponse' description: Creates a new selection list option to add to a Selection Field. deleteField: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteFieldResponse' description: Deletes a Field from the label. deleteSelectionChoice: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteSelectionChoiceResponse' description: Deletes a Choice from a Selection Field. disableField: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableFieldResponse' description: Disables Field. disableSelectionChoice: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableSelectionChoiceResponse' description: Disables a Choice within a Selection Field. enableField: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableFieldResponse' description: Enables Field. enableSelectionChoice: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableSelectionChoiceResponse' description: Enables a Choice within a Selection Field. updateField: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldPropertiesResponse' description: Updates basic properties of a Field. updateFieldType: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldTypeResponse' description: Update Field type and/or type options. updateLabel: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateLabelPropertiesResponse' description: Updated basic properties of a Label. updateSelectionChoiceProperties: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse' description: Updates a Choice within a Selection Field. type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldPropertiesResponse: description: Response following update to Field properties. properties: priority: description: The priority of the updated field. The priority may change from what was specified to assure contiguous priorities between fields (1-n). format: int32 type: integer type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldTypeResponse: description: Response following update to Field type. properties: {} type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateLabelPropertiesResponse: description: Response following update to Label properties. properties: {} type: object GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse: description: Response following update to Selection Choice properties. properties: priority: description: The priority of the updated choice. The priority may change from what was specified to assure contiguous priorities between choices (1-n). format: int32 type: integer type: object GoogleAppsDriveLabelsV2DisableLabelRequest: description: Request to deprecate a published Label. properties: disabledPolicy: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LifecycleDisabledPolicy' description: Disabled policy to use. languageCode: description: The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language will be used. type: string updateMask: description: The fields that should be updated. At least one field must be specified. The root `disabled_policy` is implied and should not be specified. A single `*` can be used as short-hand for updating every field. format: google-fieldmask type: string useAdminAccess: description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. type: boolean writeControl: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2WriteControl' description: Provides control over how write requests are executed. Defaults to unset, which means last write wins. type: object GoogleAppsDriveLabelsV2EnableLabelRequest: description: Request to enable a label. properties: languageCode: description: The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language will be used. type: string useAdminAccess: description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. type: boolean writeControl: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2WriteControl' description: Provides control over how write requests are executed. Defaults to unset, which means last write wins. type: object GoogleAppsDriveLabelsV2Field: description: Defines a field that has a display name, data type, and other configuration options. This field defines the kind of metadata that may be set on a Drive item. properties: appliedCapabilities: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldAppliedCapabilities' description: Output only. The capabilities this user has on this field and its value when the label is applied on Drive items. readOnly: true createTime: description: Output only. The time this field was created. format: google-datetime readOnly: true type: string creator: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user who created this field. readOnly: true dateOptions: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldDateOptions' description: Date field options. disableTime: description: Output only. The time this field was disabled. This value has no meaning when the field is not disabled. format: google-datetime readOnly: true type: string disabler: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user who disabled this field. This value has no meaning when the field is not disabled. readOnly: true displayHints: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldDisplayHints' description: Output only. UI display hints for rendering a field. readOnly: true id: description: 'Output only. The key of a field, unique within a label or library. This value is autogenerated. Matches the regex: `([a-zA-Z0-9])+`' readOnly: true type: string integerOptions: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldIntegerOptions' description: Integer field options. lifecycle: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Lifecycle' description: Output only. The lifecycle of this field. readOnly: true lockStatus: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LockStatus' description: Output only. The LockStatus of this field. readOnly: true properties: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldProperties' description: The basic properties of the field. publisher: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user who published this field. This value has no meaning when the field is not published. readOnly: true queryKey: description: Output only. The key to use when constructing Drive search queries to find files based on values defined for this field on files. For example, "`{query_key}` > 2001-01-01". readOnly: true type: string schemaCapabilities: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSchemaCapabilities' description: Output only. The capabilities this user has when editing this field. readOnly: true selectionOptions: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptions' description: Selection field options. textOptions: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldTextOptions' description: Text field options. updateTime: description: Output only. The time this field was updated. format: google-datetime readOnly: true type: string updater: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user who modified this field. readOnly: true userOptions: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldUserOptions' description: User field options. type: object GoogleAppsDriveLabelsV2FieldAppliedCapabilities: description: The capabilities related to this field on applied metadata. properties: canRead: description: Whether the user can read related applied metadata on items. type: boolean canSearch: description: Whether the user can search for Drive items referencing this field. type: boolean canWrite: description: Whether the user can set this field on Drive items. type: boolean type: object GoogleAppsDriveLabelsV2FieldDateOptions: description: Options for the date field type. properties: dateFormat: description: Output only. ICU date format. readOnly: true type: string dateFormatType: description: Localized date formatting option. Field values are rendered in this format according to their locale. enum: - DATE_FORMAT_UNSPECIFIED - LONG_DATE - SHORT_DATE type: string maxValue: $ref: '#/components/schemas/GoogleTypeDate' description: Output only. Maximum valid value (year, month, day). readOnly: true minValue: $ref: '#/components/schemas/GoogleTypeDate' description: Output only. Minimum valid value (year, month, day). readOnly: true type: object GoogleAppsDriveLabelsV2FieldDisplayHints: description: UI display hints for rendering a field. properties: disabled: description: Whether the field should be shown in the UI as disabled. type: boolean hiddenInSearch: description: This field should be hidden in the search menu when searching for Drive items. type: boolean required: description: Whether the field should be shown as required in the UI. type: boolean shownInApply: description: This field should be shown in the apply menu when applying values to a Drive item. type: boolean type: object GoogleAppsDriveLabelsV2FieldIntegerOptions: description: Options for the Integer field type. properties: maxValue: description: Output only. The maximum valid value for the integer field. format: int64 readOnly: true type: string minValue: description: Output only. The minimum valid value for the integer field. format: int64 readOnly: true type: string type: object GoogleAppsDriveLabelsV2FieldLimits: description: Field constants governing the structure of a Field; such as, the maximum title length, minimum and maximum field values or length, etc. properties: dateLimits: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DateLimits' description: Date Field limits. integerLimits: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2IntegerLimits' description: Integer Field limits. longTextLimits: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LongTextLimits' description: Long text Field limits. maxDescriptionLength: description: Limits for Field description, also called help text. format: int32 type: integer maxDisplayNameLength: description: Limits for Field title. format: int32 type: integer maxIdLength: description: Max length for the id. format: int32 type: integer selectionLimits: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2SelectionLimits' description: Selection Field limits. textLimits: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2TextLimits' description: The relevant limits for the specified Field.Type. Text Field limits. userLimits: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserLimits' description: User Field limits. type: object GoogleAppsDriveLabelsV2FieldListOptions: description: Options for a multi-valued variant of an associated field type. properties: maxEntries: description: Maximum number of entries permitted. format: int32 type: integer type: object GoogleAppsDriveLabelsV2FieldProperties: description: The basic properties of the field. properties: displayName: description: Required. The display text to show in the UI identifying this field. type: string insertBeforeField: description: Input only. Insert or move this field before the indicated field. If empty, the field is placed at the end of the list. type: string required: description: Whether the field should be marked as required. type: boolean type: object GoogleAppsDriveLabelsV2FieldSchemaCapabilities: description: The capabilities related to this field when editing the field. properties: canDelete: description: Whether the user can delete this field. The user must have permission and the field must be deprecated. type: boolean canDisable: description: Whether the user can disable this field. The user must have permission and this field must not already be disabled. type: boolean canEnable: description: Whether the user can enable this field. The user must have permission and this field must be disabled. type: boolean canUpdate: description: Whether the user can change this field. type: boolean type: object GoogleAppsDriveLabelsV2FieldSelectionOptions: description: Options for the selection field type. properties: choices: description: The options available for this selection field. The list order is consistent, and modified with `insert_before_choice`. items: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice' type: array listOptions: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldListOptions' description: When specified, indicates this field supports a list of values. Once the field is published, this cannot be changed. type: object GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice: description: Selection field choice. properties: appliedCapabilities: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceAppliedCapabilities' description: Output only. The capabilities related to this choice on applied metadata. readOnly: true createTime: description: Output only. The time this choice was created. format: google-datetime readOnly: true type: string creator: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user who created this choice. readOnly: true disableTime: description: Output only. The time this choice was disabled. This value has no meaning when the choice is not disabled. format: google-datetime readOnly: true type: string disabler: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user who disabled this choice. This value has no meaning when the option is not disabled. readOnly: true displayHints: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceDisplayHints' description: Output only. UI display hints for rendering a choice. readOnly: true id: description: 'The unique value of the choice. This ID is autogenerated. Matches the regex: `([a-zA-Z0-9_])+`.' type: string lifecycle: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Lifecycle' description: Output only. Lifecycle of the choice. readOnly: true lockStatus: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LockStatus' description: Output only. The LockStatus of this choice. readOnly: true properties: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties' description: Basic properties of the choice. publishTime: description: Output only. The time this choice was published. This value has no meaning when the choice is not published. format: google-datetime readOnly: true type: string publisher: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user who published this choice. This value has no meaning when the choice is not published. readOnly: true schemaCapabilities: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceSchemaCapabilities' description: Output only. The capabilities related to this option when editing the option. readOnly: true updateTime: description: Output only. The time this choice was updated last. format: google-datetime readOnly: true type: string updater: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user who updated this choice last. readOnly: true type: object GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceAppliedCapabilities: description: The capabilities related to this choice on applied metadata. properties: canRead: description: Whether the user can read related applied metadata on items. type: boolean canSearch: description: Whether the user can use this choice in search queries. type: boolean canSelect: description: Whether the user can select this choice on an item. type: boolean type: object GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceDisplayHints: description: UI display hints for rendering an option. properties: badgeColors: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2BadgeColors' description: The colors to use for the badge. Changed to Google Material colors based on the chosen `properties.badge_config.color`. badgePriority: description: The priority of this badge. Used to compare and sort between multiple badges. A lower number means the badge should be shown first. When a badging configuration is not present, this will be 0. Otherwise, this will be set to `BadgeConfig.priority_override` or the default heuristic which prefers creation date of the label, and field and option priority. format: int64 type: string darkBadgeColors: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2BadgeColors' description: The dark-mode color to use for the badge. Changed to Google Material colors based on the chosen `properties.badge_config.color`. disabled: description: Whether the option should be shown in the UI as disabled. type: boolean hiddenInSearch: description: This option should be hidden in the search menu when searching for Drive items. type: boolean shownInApply: description: This option should be shown in the apply menu when applying values to a Drive item. type: boolean type: object GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties: description: Basic properties of the choice. properties: badgeConfig: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2BadgeConfig' description: The badge configuration for this choice. When set, the label that owns this choice is considered a "badged label". description: description: The description of this label. type: string displayName: description: Required. The display text to show in the UI identifying this field. type: string insertBeforeChoice: description: Input only. Insert or move this choice before the indicated choice. If empty, the choice is placed at the end of the list. type: string type: object GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceSchemaCapabilities: description: The capabilities related to this choice when editing the choice. properties: canDelete: description: Whether the user can delete this choice. type: boolean canDisable: description: Whether the user can disable this choice. type: boolean canEnable: description: Whether the user can enable this choice. type: boolean canUpdate: description: Whether the user can update this choice. type: boolean type: object GoogleAppsDriveLabelsV2FieldTextOptions: description: Options for the Text field type. properties: maxLength: description: Output only. The maximum valid length of values for the text field. format: int32 readOnly: true type: integer minLength: description: Output only. The minimum valid length of values for the text field. format: int32 readOnly: true type: integer type: object GoogleAppsDriveLabelsV2FieldUserOptions: description: Options for the user field type. properties: listOptions: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldListOptions' description: When specified, indicates that this field supports a list of values. Once the field is published, this cannot be changed. type: object GoogleAppsDriveLabelsV2IntegerLimits: description: Limits for integer Field type. properties: maxValue: description: Maximum value for an integer Field type. format: int64 type: string minValue: description: Minimum value for an integer Field type. format: int64 type: string type: object GoogleAppsDriveLabelsV2Label: description: A label defines a taxonomy that can be applied to Drive items in order to organize and search across items. Labels can be simple strings, or can contain fields that describe additional metadata that can be further used to organize and search Drive items. properties: appliedCapabilities: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelAppliedCapabilities' description: Output only. The capabilities related to this label on applied metadata. readOnly: true appliedLabelPolicy: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelAppliedLabelPolicy' description: Output only. Behavior of this label when it's applied to Drive items. readOnly: true createTime: description: Output only. The time this label was created. format: google-datetime readOnly: true type: string creator: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user who created this label. readOnly: true customer: description: 'Output only. The customer this label belongs to. For example: "customers/123abc789."' readOnly: true type: string disableTime: description: Output only. The time this label was disabled. This value has no meaning when the label is not disabled. format: google-datetime readOnly: true type: string disabler: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user who disabled this label. This value has no meaning when the label is not disabled. readOnly: true displayHints: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelDisplayHints' description: Output only. UI display hints for rendering the label. readOnly: true fields: description: List of fields in descending priority order. items: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Field' type: array id: description: 'Output only. Globally unique identifier of this label. ID makes up part of the label `name`, but unlike `name`, ID is consistent between revisions. Matches the regex: `([a-zA-Z0-9])+`' readOnly: true type: string labelType: description: Required. The type of label. enum: - LABEL_TYPE_UNSPECIFIED - SHARED - ADMIN - GOOGLE_APP type: string learnMoreUri: description: Custom URL to present to users to allow them to learn more about this label and how it should be used. type: string lifecycle: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Lifecycle' description: Output only. The lifecycle state of the label including whether it's published, deprecated, and has draft changes. readOnly: true lockStatus: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LockStatus' description: Output only. The LockStatus of this label. readOnly: true name: description: 'Output only. Resource name of the label. Will be in the form of either: `labels/{id}` or `labels/{id}@{revision_id}` depending on the request. See `id` and `revision_id` below.' readOnly: true type: string properties: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelProperties' description: Required. The basic properties of the label. publishTime: description: Output only. The time this label was published. This value has no meaning when the label is not published. format: google-datetime readOnly: true type: string publisher: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user who published this label. This value has no meaning when the label is not published. readOnly: true revisionCreateTime: description: Output only. The time this label revision was created. format: google-datetime readOnly: true type: string revisionCreator: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user who created this label revision. readOnly: true revisionId: description: 'Output only. Revision ID of the label. Revision ID might be part of the label `name` depending on the request issued. A new revision is created whenever revisioned properties of a label are changed. Matches the regex: `([a-zA-Z0-9])+`' readOnly: true type: string schemaCapabilities: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelSchemaCapabilities' description: Output only. The capabilities the user has on this label. readOnly: true type: object GoogleAppsDriveLabelsV2LabelAppliedCapabilities: description: The capabilities a user has on this label's applied metadata. properties: canApply: description: Whether the user can apply this label to items. type: boolean canRead: description: Whether the user can read applied metadata related to this label. type: boolean canRemove: description: Whether the user can remove this label from items. type: boolean type: object GoogleAppsDriveLabelsV2LabelAppliedLabelPolicy: description: Behavior of this label when it's applied to Drive items. properties: copyMode: description: Indicates how the applied label and field values should be copied when a Drive item is copied. enum: - COPY_MODE_UNSPECIFIED - DO_NOT_COPY - ALWAYS_COPY - COPY_APPLIABLE type: string type: object GoogleAppsDriveLabelsV2LabelDisplayHints: description: UI display hints for rendering the label. properties: disabled: description: Whether the label should be shown in the UI as disabled. type: boolean hiddenInSearch: description: This label should be hidden in the search menu when searching for Drive items. type: boolean priority: description: Order to display label in a list. format: int64 type: string shownInApply: description: This label should be shown in the apply menu when applying values to a Drive item. type: boolean type: object GoogleAppsDriveLabelsV2LabelLimits: description: Label constraints governing the structure of a Label; such as, the maximum number of Fields allowed and maximum length of the label title. properties: fieldLimits: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldLimits' description: The limits for Fields. maxDeletedFields: description: The maximum number of published Fields that can be deleted. format: int32 type: integer maxDescriptionLength: description: The maximum number of characters allowed for the description. format: int32 type: integer maxDraftRevisions: description: The maximum number of draft revisions that will be kept before deleting old drafts. format: int32 type: integer maxFields: description: The maximum number of Fields allowed within the label. format: int32 type: integer maxTitleLength: description: The maximum number of characters allowed for the title. format: int32 type: integer name: description: Resource name. type: string type: object GoogleAppsDriveLabelsV2LabelLock: description: A Lock that can be applied to a Label, Field, or Choice. properties: capabilities: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelLockCapabilities' description: Output only. The user's capabilities on this LabelLock. readOnly: true choiceId: description: The ID of the Selection Field Choice that should be locked. If present, `field_id` must also be present. type: string createTime: description: Output only. The time this LabelLock was created. format: google-datetime readOnly: true type: string creator: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' description: Output only. The user whose credentials were used to create the LabelLock. This will not be present if no user was responsible for creating the LabelLock. readOnly: true deleteTime: description: Output only. A timestamp indicating when this LabelLock was scheduled for deletion. This will be present only if this LabelLock is in the DELETING state. format: google-datetime readOnly: true type: string fieldId: description: The ID of the Field that should be locked. Empty if the whole Label should be locked. type: string name: description: Output only. Resource name of this LabelLock. readOnly: true type: string state: description: Output only. This LabelLock's state. enum: - STATE_UNSPECIFIED - ACTIVE - DELETING readOnly: true type: string type: object GoogleAppsDriveLabelsV2LabelLockCapabilities: description: A description of a user's capabilities on a LabelLock. properties: canViewPolicy: description: True if the user is authorized to view the policy. type: boolean type: object GoogleAppsDriveLabelsV2LabelPermission: description: The permission that applies to a principal (user, group, audience) on a label. properties: audience: description: Audience to grant a role to. The magic value of `audiences/default` may be used to apply the role to the default audience in the context of the organization that owns the Label. type: string email: description: Specifies the email address for a user or group pricinpal. Not populated for audience principals. User and Group permissions may only be inserted using email address. On update requests, if email address is specified, no principal should be specified. type: string group: description: Group resource name. type: string name: description: Resource name of this permission. type: string person: description: Person resource name. type: string role: description: The role the principal should have. enum: - LABEL_ROLE_UNSPECIFIED - READER - APPLIER - ORGANIZER - EDITOR type: string type: object GoogleAppsDriveLabelsV2LabelProperties: description: Basic properties of the label. properties: description: description: The description of the label. type: string title: description: Required. Title of the label. type: string type: object GoogleAppsDriveLabelsV2LabelSchemaCapabilities: description: The capabilities related to this label when editing the label. properties: canDelete: description: Whether the user can delete this label. The user must have permission and the label must be disabled. type: boolean canDisable: description: Whether the user can disable this label. The user must have permission and this label must not already be disabled. type: boolean canEnable: description: Whether the user can enable this label. The user must have permission and this label must be disabled. type: boolean canUpdate: description: Whether the user can change this label. type: boolean type: object GoogleAppsDriveLabelsV2Lifecycle: description: 'The lifecycle state of an object, such as label, field, or choice. The lifecycle enforces the following transitions: * `UNPUBLISHED_DRAFT` (starting state) * `UNPUBLISHED_DRAFT` -> `PUBLISHED` * `UNPUBLISHED_DRAFT` -> (Deleted) * `PUBLISHED` -> `DISABLED` * `DISABLED` -> `PUBLISHED` * `DISABLED` -> (Deleted) The published and disabled states have some distinct characteristics: * Published—Some kinds of changes might be made to an object in this state, in which case `has_unpublished_changes` will be true. Also, some kinds of changes are not permitted. Generally, any change that would invalidate or cause new restrictions on existing metadata related to the label are rejected. * Disabled—When disabled, the configured `DisabledPolicy` takes effect.' properties: disabledPolicy: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LifecycleDisabledPolicy' description: The policy that governs how to show a disabled label, field, or selection choice. hasUnpublishedChanges: description: Output only. Whether the object associated with this lifecycle has unpublished changes. readOnly: true type: boolean state: description: Output only. The state of the object associated with this lifecycle. enum: - STATE_UNSPECIFIED - UNPUBLISHED_DRAFT - PUBLISHED - DISABLED - DELETED readOnly: true type: string type: object GoogleAppsDriveLabelsV2LifecycleDisabledPolicy: description: The policy that governs how to treat a disabled label, field, or selection choice in different contexts. properties: hideInSearch: description: Whether to hide this disabled object in the search menu for Drive items. * When `false`, the object is generally shown in the UI as disabled but it appears in the search results when searching for Drive items. * When `true`, the object is generally hidden in the UI when searching for Drive items. type: boolean showInApply: description: Whether to show this disabled object in the apply menu on Drive items. * When `true`, the object is generally shown in the UI as disabled and is unselectable. * When `false`, the object is generally hidden in the UI. type: boolean type: object GoogleAppsDriveLabelsV2ListLabelLocksResponse: description: The response to a ListLabelLocksRequest. properties: labelLocks: description: LabelLocks. items: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelLock' type: array nextPageToken: description: The token of the next page in the response. type: string type: object GoogleAppsDriveLabelsV2ListLabelPermissionsResponse: description: Response for listing the permissions on a Label. properties: labelPermissions: description: Label permissions. items: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' type: array nextPageToken: description: The token of the next page in the response. type: string type: object GoogleAppsDriveLabelsV2ListLabelsResponse: description: Response for listing Labels. properties: labels: description: Labels. items: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' type: array nextPageToken: description: The token of the next page in the response. type: string type: object GoogleAppsDriveLabelsV2ListLimits: description: Limits for list-variant of a Field type. properties: maxEntries: description: Maximum number of values allowed for the Field type. format: int32 type: integer type: object GoogleAppsDriveLabelsV2LockStatus: description: Contains information about whether a label component should be considered locked. properties: locked: description: Output only. Indicates whether this label component is the (direct) target of a LabelLock. A label component can be implicitly locked even if it's not the direct target of a LabelLock, in which case this field is set to false. readOnly: true type: boolean type: object GoogleAppsDriveLabelsV2LongTextLimits: description: Limits for long text Field type. properties: maxLength: description: Maximum length allowed for a long text Field type. format: int32 type: integer minLength: description: Minimum length allowed for a long text Field type. format: int32 type: integer type: object GoogleAppsDriveLabelsV2PublishLabelRequest: description: Request to publish a label. properties: languageCode: description: The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language will be used. type: string useAdminAccess: description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. type: boolean writeControl: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2WriteControl' description: Provides control over how write requests are executed. Defaults to unset, which means last write wins. type: object GoogleAppsDriveLabelsV2SelectionLimits: description: Limits for selection Field type. properties: listLimits: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2ListLimits' description: Limits for list-variant of a Field type. maxChoices: description: The max number of choices. format: int32 type: integer maxDeletedChoices: description: Maximum number of deleted choices. format: int32 type: integer maxDisplayNameLength: description: Maximum length for display name. format: int32 type: integer maxIdLength: description: Maximum ID length for a selection options. format: int32 type: integer type: object GoogleAppsDriveLabelsV2TextLimits: description: Limits for text Field type. properties: maxLength: description: Maximum length allowed for a text Field type. format: int32 type: integer minLength: description: Minimum length allowed for a text Field type. format: int32 type: integer type: object GoogleAppsDriveLabelsV2UpdateLabelCopyModeRequest: description: Request to update the `CopyMode` of the given Label. Changes to this policy are not revisioned, do not require publishing, and take effect immediately. \ properties: copyMode: description: Required. Indicates how the applied Label, and Field values should be copied when a Drive item is copied. enum: - COPY_MODE_UNSPECIFIED - DO_NOT_COPY - ALWAYS_COPY - COPY_APPLIABLE type: string languageCode: description: The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language will be used. type: string useAdminAccess: description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. type: boolean view: description: When specified, only certain fields belonging to the indicated view will be returned. enum: - LABEL_VIEW_BASIC - LABEL_VIEW_FULL type: string type: object GoogleAppsDriveLabelsV2UpdateLabelPermissionRequest: description: Updates a Label Permission. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing. properties: labelPermission: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' description: Required. The permission to create or update on the Label. parent: description: Required. The parent Label resource name. type: string useAdminAccess: description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. type: boolean type: object GoogleAppsDriveLabelsV2UserCapabilities: description: The capabilities of a user. properties: canAccessLabelManager: description: Output only. Whether the user is allowed access to the label manager. readOnly: true type: boolean canAdministrateLabels: description: Output only. Whether the user is an administrator for the shared labels feature. readOnly: true type: boolean canCreateAdminLabels: description: Output only. Whether the user is allowed to create new admin labels. readOnly: true type: boolean canCreateSharedLabels: description: Output only. Whether the user is allowed to create new shared labels. readOnly: true type: boolean name: description: Output only. Resource name for the user capabilities. readOnly: true type: string type: object GoogleAppsDriveLabelsV2UserInfo: description: Information about a user. properties: person: description: The identifier for this user that can be used with the People API to get more information. For example, people/12345678. type: string type: object GoogleAppsDriveLabelsV2UserLimits: description: Limits for Field.Type.USER. properties: listLimits: $ref: '#/components/schemas/GoogleAppsDriveLabelsV2ListLimits' description: Limits for list-variant of a Field type. type: object GoogleAppsDriveLabelsV2WriteControl: description: Provides control over how write requests are executed. When not specified, the last write wins. properties: requiredRevisionId: description: The revision_id of the label that the write request will be applied to. If this is not the latest revision of the label, the request will not be processed and will return a 400 Bad Request error. type: string type: object GoogleProtobufEmpty: description: 'A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }' properties: {} type: object GoogleTypeColor: description: 'Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor''s `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn''t have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!(''alpha'' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join('',''); return [''rgba('', rgbParams, '','', alphaFrac, '')''].join(''''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = [''#'']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push(''0''); } resultBuilder.push(hexString); return resultBuilder.join(''''); }; // ...' properties: alpha: description: 'The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).' format: float type: number blue: description: The amount of blue in the color as a value in the interval [0, 1]. format: float type: number green: description: The amount of green in the color as a value in the interval [0, 1]. format: float type: number red: description: The amount of red in the color as a value in the interval [0, 1]. format: float type: number type: object GoogleTypeDate: description: 'Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp' properties: day: description: Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. format: int32 type: integer month: description: Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. format: int32 type: integer year: description: Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. format: int32 type: integer type: object examples: {} securitySchemes: Oauth2: description: Oauth 2.0 implicit authentication flows: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: https://www.googleapis.com/auth/drive.admin.labels: See, edit, create, and delete all Google Drive labels in your organization, and see your organization's label-related admin policies https://www.googleapis.com/auth/drive.admin.labels.readonly: See all Google Drive labels and label-related admin policies in your organization https://www.googleapis.com/auth/drive.labels: See, edit, create, and delete your Google Drive labels https://www.googleapis.com/auth/drive.labels.readonly: See your Google Drive labels type: oauth2 Oauth2c: description: Oauth 2.0 authorizationCode authentication flows: authorizationCode: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: https://www.googleapis.com/auth/drive.admin.labels: See, edit, create, and delete all Google Drive labels in your organization, and see your organization's label-related admin policies https://www.googleapis.com/auth/drive.admin.labels.readonly: See all Google Drive labels and label-related admin policies in your organization https://www.googleapis.com/auth/drive.labels: See, edit, create, and delete your Google Drive labels https://www.googleapis.com/auth/drive.labels.readonly: See your Google Drive labels tokenUrl: https://accounts.google.com/o/oauth2/token type: oauth2 parameters: _.xgafv: description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string alt: description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string callback: description: JSONP in: query name: callback schema: type: string fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string key: description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. in: query name: key schema: type: string oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean quotaUser: description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. in: query name: quotaUser schema: type: string uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string