{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/google/json-schema/google-google-apps-drive-labels-v2-delta-update-label-request-schema.json", "title": "GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest", "description": "The set of requests for updating aspects of a Label. If any request is not valid, no requests will be applied.", "x-generated": "2026-11-04", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/google-labels-api-openapi.yml#/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest", "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": "#/$defs/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": "#/$defs/GoogleAppsDriveLabelsV2WriteControl", "description": "Provides control over how write requests are executed." } }, "type": "object", "$defs": { "GoogleAppsDriveLabelsV2BadgeColors": { "description": "The color derived from BadgeConfig and changed to the closest recommended supported color.", "properties": { "backgroundColor": { "$ref": "#/$defs/GoogleTypeColor", "description": "Output only. Badge background that pairs with the foreground.", "readOnly": true }, "foregroundColor": { "$ref": "#/$defs/GoogleTypeColor", "description": "Output only. Badge foreground that pairs with the background.", "readOnly": true }, "soloColor": { "$ref": "#/$defs/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": "#/$defs/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" }, "GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateFieldRequest": { "description": "Request to create a Field within a Label.", "properties": { "field": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2Field", "description": "Required. Field to create." } }, "type": "object" }, "GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateSelectionChoiceRequest": { "description": "Request to create a Selection Choice.", "properties": { "choice": { "$ref": "#/$defs/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": "#/$defs/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": "#/$defs/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": "#/$defs/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateFieldRequest", "description": "Creates a new Field." }, "createSelectionChoice": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateSelectionChoiceRequest", "description": "Creates Choice within a Selection field." }, "deleteField": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteFieldRequest", "description": "Deletes a Field from the label." }, "deleteSelectionChoice": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteSelectionChoiceRequest", "description": "Delete a Choice within a Selection Field." }, "disableField": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableFieldRequest", "description": "Disables the Field." }, "disableSelectionChoice": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableSelectionChoiceRequest", "description": "Disable a Choice within a Selection Field." }, "enableField": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableFieldRequest", "description": "Enables the Field." }, "enableSelectionChoice": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableSelectionChoiceRequest", "description": "Enable a Choice within a Selection Field." }, "updateField": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldPropertiesRequest", "description": "Updates basic properties of a Field." }, "updateFieldType": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldTypeRequest", "description": "Update Field type and/or type options." }, "updateLabel": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateLabelPropertiesRequest", "description": "Updates the Label properties." }, "updateSelectionChoiceProperties": { "$ref": "#/$defs/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": "#/$defs/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": "#/$defs/GoogleAppsDriveLabelsV2FieldDateOptions", "description": "Update field to Date." }, "id": { "description": "Required. The Field to update.", "type": "string" }, "integerOptions": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2FieldIntegerOptions", "description": "Update field to Integer." }, "selectionOptions": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2FieldSelectionOptions", "description": "Update field to Selection." }, "textOptions": { "$ref": "#/$defs/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": "#/$defs/GoogleAppsDriveLabelsV2FieldUserOptions", "description": "Update field to User." } }, "type": "object" }, "GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateLabelPropertiesRequest": { "description": "Updates basic properties of a Label.", "properties": { "properties": { "$ref": "#/$defs/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": "#/$defs/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" }, "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": "#/$defs/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": "#/$defs/GoogleAppsDriveLabelsV2UserInfo", "description": "Output only. The user who created this field.", "readOnly": true }, "dateOptions": { "$ref": "#/$defs/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": "#/$defs/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": "#/$defs/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": "#/$defs/GoogleAppsDriveLabelsV2FieldIntegerOptions", "description": "Integer field options." }, "lifecycle": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2Lifecycle", "description": "Output only. The lifecycle of this field.", "readOnly": true }, "lockStatus": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2LockStatus", "description": "Output only. The LockStatus of this field.", "readOnly": true }, "properties": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2FieldProperties", "description": "The basic properties of the field." }, "publisher": { "$ref": "#/$defs/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": "#/$defs/GoogleAppsDriveLabelsV2FieldSchemaCapabilities", "description": "Output only. The capabilities this user has when editing this field.", "readOnly": true }, "selectionOptions": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2FieldSelectionOptions", "description": "Selection field options." }, "textOptions": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2FieldTextOptions", "description": "Text field options." }, "updateTime": { "description": "Output only. The time this field was updated.", "format": "google-datetime", "readOnly": true, "type": "string" }, "updater": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2UserInfo", "description": "Output only. The user who modified this field.", "readOnly": true }, "userOptions": { "$ref": "#/$defs/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": "#/$defs/GoogleTypeDate", "description": "Output only. Maximum valid value (year, month, day).", "readOnly": true }, "minValue": { "$ref": "#/$defs/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" }, "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": "#/$defs/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice" }, "type": "array" }, "listOptions": { "$ref": "#/$defs/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": "#/$defs/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": "#/$defs/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": "#/$defs/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": "#/$defs/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": "#/$defs/GoogleAppsDriveLabelsV2Lifecycle", "description": "Output only. Lifecycle of the choice.", "readOnly": true }, "lockStatus": { "$ref": "#/$defs/GoogleAppsDriveLabelsV2LockStatus", "description": "Output only. The LockStatus of this choice.", "readOnly": true }, "properties": { "$ref": "#/$defs/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": "#/$defs/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": "#/$defs/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": "#/$defs/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": "#/$defs/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": "#/$defs/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": "#/$defs/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": "#/$defs/GoogleAppsDriveLabelsV2FieldListOptions", "description": "When specified, indicates that this field supports a list of values. Once the field is published, this cannot be changed." } }, "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" }, "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": "#/$defs/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" }, "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" }, "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" }, "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" }, "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" } } }