package google.apps.drive.labels.v2
Get desktop application:
View/edit binary Protocol Buffers messages
Manage metadata taxonomies based on Labels and Fields that may be used within Google Drive to organize and find files using custom metadata.
Gets the user capabilities.
message
requests.proto:62Request to get the capabilities for a user.
string name = 1
Required. The resource name of the user. Only "users/me/capabilities" is supported.
string customer = 2
The customer to scope this request to. For example: "customers/abcd1234". If unset, will return settings within the current customer.
message
user_capabilities.proto:29The capabilities of a user.
string name = 1
Output only. Resource name for the user capabilities.
bool can_access_label_manager = 2
Output only. Whether the user is allowed access to the label manager.
bool can_administrate_labels = 3
Output only. Whether the user is an administrator for the shared labels feature.
bool can_create_shared_labels = 4
Output only. Whether the user is allowed to create new shared labels.
bool can_create_admin_labels = 5
Output only. Whether the user is allowed to create new admin labels.
rpc ListLabels (, )
label_service.proto:54List labels.
message
requests.proto:503Request to list labels available to the current user.
oneof access
bool use_admin_access = 3
Set to `true` in order to use the user's admin credentials. This will return all Labels within the customer.
LabelPermission.LabelRole minimum_role = 4
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`.
bool published_only = 1
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}`).
string customer = 2
The customer to scope this list request to. For example: "customers/abcd1234". If unset, will return all labels within the current customer.
string language_code = 5
The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language are used.
int32 page_size = 6
Maximum number of labels to return per page. Default: 50. Max: 200.
string page_token = 7
The token of the page to return.
LabelView view = 8
When specified, only certain fields belonging to the indicated view are returned.
message
requests.proto:548Response for listing Labels.
repeated labels = 1
Labels.
string next_page_token = 2
The token of the next page in the response.
rpc GetLabel (, )
label_service.proto:69Get a label by its resource name. Resource name may be any of: * `labels/{id}` - See `labels/{id}@latest` * `labels/{id}@latest` - Gets the latest revision of the label. * `labels/{id}@published` - Gets the current published revision of the label. * `labels/{id}@{revision_id}` - Gets the label at the specified revision ID.
message
requests.proto:96Request to get a label by resource name.
string name = 1
Required. Label resource name. May be any of: * `labels/{id}` (equivalent to labels/{id}@latest) * `labels/{id}@latest` * `labels/{id}@published` * `labels/{id}@{revision_id}`
bool use_admin_access = 2
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.
string language_code = 3
The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language are used.
LabelView view = 4
When specified, only certain fields belonging to the indicated view are returned.
rpc GetLabelLimits (, )
label_service.proto:78Get the constraints on the structure of a Label; such as, the maximum number of Fields allowed and maximum length of the label title.
message
requests.proto:491Request to get the limits for a Label.
string name = 1
Required. Label revision resource name Must be: "limits/label"
message
label_limits.proto:30Label constraints governing the structure of a Label; such as, the maximum number of Fields allowed and maximum length of the label title.
string name = 1
Resource name.
int32 max_title_length = 2
The maximum number of characters allowed for the title.
int32 max_description_length = 3
The maximum number of characters allowed for the description.
int32 max_fields = 4
The maximum number of Fields allowed within the label.
int32 max_deleted_fields = 5
The maximum number of published Fields that can be deleted.
int32 max_draft_revisions = 6
The maximum number of draft revisions that will be kept before deleting old drafts.
optional field_limits = 7
The limits for Fields.
rpc CreateLabel (, )
label_service.proto:85Creates a new Label.
message
requests.proto:81Request to create a Label.
optional label = 1
Required. The label to create.
bool use_admin_access = 2
Set to `true` in order to use the user's admin privileges. The server will verify the user is an admin before allowing access.
string language_code = 3
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.
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.
message
requests.proto:127The set of requests for updating aspects of a Label. If any request is not valid, no requests will be applied.
string name = 1
Required. The resource name of the Label to update.
optional write_control = 2
Provides control over how write requests are executed.
repeated requests = 3
A list of updates to apply to the Label. Requests will be applied in the order they are specified.
bool use_admin_access = 4
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.
LabelView view = 5
When specified, only certain fields belonging to the indicated view will be returned.
string language_code = 6
The BCP-47 language code to use for evaluating localized Field labels when `include_label_in_response` is `true`.
message
requests.proto:350Response for Label update.
repeated responses = 1
The reply of the updates. This maps 1:1 with the updates, although responses to some requests may be empty.
optional updated_label = 6
The label after updates were applied. This is only set if [BatchUpdateLabelResponse2.include_label_in_response] is `true` and there were no errors.
Updates a Label's `CopyMode`. Changes to this policy are not revisioned, do not require publishing, and take effect immediately.
message
requests.proto:465Request to update the `CopyMode` of the given Label. Changes to this policy are not revisioned, do not require publishing, and take effect immediately. \
string name = 1
Required. The resource name of the Label to update.
Label.AppliedLabelPolicy.CopyMode copy_mode = 2
Required. Indicates how the applied Label, and Field values should be copied when a Drive item is copied.
bool use_admin_access = 3
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.
string language_code = 4
The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language will be used.
LabelView view = 5
When specified, only certain fields belonging to the indicated view will be returned.
rpc PublishLabel (, )
label_service.proto:134Publish 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.
message
requests.proto:731Request to publish a label.
string name = 1
Required. Label resource name.
bool use_admin_access = 2
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.
optional write_control = 3
Provides control over how write requests are executed. Defaults to unset, which means last write wins.
string language_code = 4
The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language will be used.
rpc DisableLabel (, )
label_service.proto:149Disable 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`.
message
requests.proto:700Request to deprecate a published Label.
optional update_mask = 1
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.
string name = 2
Required. Label resource name.
bool use_admin_access = 3
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.
optional write_control = 4
Provides control over how write requests are executed. Defaults to unset, which means last write wins.
optional disabled_policy = 5
Disabled policy to use.
string language_code = 6
The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language will be used.
rpc EnableLabel (, )
label_service.proto:161Enable 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.
message
requests.proto:754Request to enable a label.
string name = 1
Required. Label resource name.
bool use_admin_access = 2
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.
optional write_control = 3
Provides control over how write requests are executed. Defaults to unset, which means last write wins.
string language_code = 4
The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language will be used.
rpc DeleteLabel (, )
label_service.proto:173Permanently deletes a Label and related metadata on Drive Items. Once deleted, the Label and related Drive item metadata will be deleted. Only draft Labels, and disabled Labels may be deleted.
message
requests.proto:777Request to delete a label.
string name = 1
Required. Label resource name.
bool use_admin_access = 2
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.
optional write_control = 3
Provides control over how write requests are executed. Defaults to unset, which means last write wins.
Lists a Label's permissions.
message
requests.proto:577Request to list the permissions on a Label.
string parent = 1
Required. The parent Label resource name on which Label Permission are listed. Format: labels/{label}
bool use_admin_access = 2
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.
int32 page_size = 3
Maximum number of permissions to return per page. Default: 50. Max: 200.
string page_token = 4
The token of the page to return.
message
requests.proto:599Response for listing the permissions on a Label.
repeated label_permissions = 1
Label permissions.
string next_page_token = 2
The token of the next page in the response.
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.
message
requests.proto:558Creates or updates a permission on the Label. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.
string parent = 1
Required. The parent Label resource name on the Label Permission is created. Format: labels/{label}
optional label_permission = 2
Required. The permission to create or update on the Label.
bool use_admin_access = 3
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.
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.
Deletes a Label's permission. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.
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.
message
requests.proto:643Updates one or more Label Permissions.
string parent = 1
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.
repeated requests = 2
Required. The request message specifying the resources to update.
bool use_admin_access = 3
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.
message
requests.proto:668Response for updating one or more Label Permissions.
repeated permissions = 1
Required. Permissions updated.
Deletes Label permissions. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.
message
requests.proto:675Deletes one of more Label Permissions.
repeated requests = 1
Required. The request message specifying the resources to update.
bool use_admin_access = 2
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.
string parent = 3
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.
Lists the LabelLocks on a Label.
message
requests.proto:796A request to list the LabelLocks on a Label.
string parent = 1
Required. Label on which Locks are applied. Format: labels/{label}
int32 page_size = 2
Maximum number of Locks to return per page. Default: 100. Max: 200.
string page_token = 3
The token of the page to return.
message
requests.proto:814The response to a ListLabelLocksRequest.
repeated label_locks = 1
LabelLocks.
string next_page_token = 2
The token of the next page in the response.
message
common.proto:130The color derived from BadgeConfig and changed to the closest recommended supported color.
Used in:
optional background_color = 1
Output only. Badge background that pairs with the foreground.
optional foreground_color = 2
Output only. Badge foreground that pairs with the background.
optional solo_color = 3
Output only. Color that can be used for text without a background.
message
common.proto:117Badge status of the label.
Used in:
optional color = 1
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.
int64 priority_override = 2
Override the default global priority of this badge. When set to 0, the default priority heuristic is used.
message
label_limits.proto:125Limits for date Field type.
Used in:
optional min_value = 1
Minimum value for the date Field type.
optional max_value = 2
Maximum value for the date Field type.
message
requests.proto:628Deletes a Label Permission. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.
Used as request type in: LabelService.DeleteLabelPermission
Used as field type in:
string name = 1
Required. Label Permission resource name.
bool use_admin_access = 2
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.
message
requests.proto:210Request to create a Field within a Label.
Used in:
optional field = 1
Required. Field to create.
message
requests.proto:258Request to create a Selection Choice.
Used in:
string field_id = 1
Required. The Selection Field in which a Choice will be created.
optional choice = 2
Required. The Choice to create.
message
requests.proto:204Request to delete the Field.
Used in:
string id = 1
Required. ID of the Field to delete.
message
requests.proto:286Request to delete a Choice.
Used in:
string field_id = 1
Required. The Selection Field from which a Choice will be deleted.
string id = 2
Required. Choice to delete.
message
requests.proto:183Request to disable the Field.
Used in:
optional update_mask = 1
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.
string id = 2
Required. Key of the Field to disable.
optional disabled_policy = 3
Required. Field Disabled Policy.
message
requests.proto:295Request to disable a Choice.
Used in:
optional update_mask = 1
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.
string field_id = 2
Required. The Selection Field in which a Choice will be disabled.
string id = 3
Required. Choice to disable.
optional disabled_policy = 4
Required. The disabled policy to update.
message
requests.proto:198Request to enable the Field.
Used in:
string id = 1
Required. ID of the Field to enable.
message
requests.proto:313Request to enable a Choice.
Used in:
string field_id = 1
Required. The Selection Field in which a Choice will be enabled.
string id = 2
Required. Choice to enable.
message
requests.proto:129A single kind of update to apply to a Label.
Used in:
oneof kind
The kind of update. Exactly one Field is required.
update_label = 1
Updates the Label properties.
create_field = 2
Creates a new Field.
update_field = 3
Updates basic properties of a Field.
update_field_type = 4
Update Field type and/or type options.
enable_field = 5
Enables the Field.
disable_field = 6
Disables the Field.
delete_field = 7
Deletes a Field from the label.
create_selection_choice = 8
Creates Choice within a Selection field.
update_selection_choice_properties = 9
Update a Choice properties within a Selection Field.
enable_selection_choice = 10
Enable a Choice within a Selection Field.
disable_selection_choice = 11
Disable a Choice within a Selection Field.
delete_selection_choice = 12
Delete a Choice within a Selection Field.
message
requests.proto:216Request to update Field properties.
Used in:
optional update_mask = 1
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.
string id = 2
Required. The Field to update.
optional properties = 3
Required. Basic Field properties.
message
requests.proto:230Request to change the type of a Field.
Used in:
oneof type_options
text_options = 3
Update field to Text.
integer_options = 5
Update field to Integer.
date_options = 6
Update field to Date.
selection_options = 7
Update field to Selection.
user_options = 8
Update field to User.
optional update_mask = 1
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.
string id = 2
Required. The Field to update.
message
requests.proto:172Updates basic properties of a Label.
Used in:
optional update_mask = 1
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.
optional properties = 2
Required. Label properties to update.
message
requests.proto:268Request to update a Choice properties.
Used in:
optional update_mask = 1
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.
string field_id = 2
Required. The Selection Field to update.
string id = 3
Required. The Choice to update.
optional properties = 4
Required. The Choice properties to update.
message
requests.proto:398Response following Field create.
Used in:
string id = 1
The field of the created field. When left blank in a create request, a key will be autogenerated and can be identified here.
int32 priority = 2
The priority of the created field. The priority may change from what was specified to assure contiguous priorities between fields (1-n).
message
requests.proto:428Response following Selection Choice create.
Used in:
string field_id = 1
The server-generated id of the field.
string id = 2
The server-generated ID of the created choice within the Field
message
requests.proto:425Response following Field delete.
Used in:
(message has no fields)
message
requests.proto:450Response following Choice delete.
Used in:
(message has no fields)
message
requests.proto:422Response following Field disable.
Used in:
(message has no fields)
message
requests.proto:447Response following Choice disable.
Used in:
(message has no fields)
message
requests.proto:419Response following Field enable.
Used in:
(message has no fields)
message
requests.proto:444Response following Choice enable.
Used in:
(message has no fields)
message
requests.proto:352A single response from an update.
Used in:
oneof response
The response for the corresponding request.
update_label = 1
Updated basic properties of a Label.
create_field = 2
Creates a new Field.
update_field = 3
Updates basic properties of a Field.
update_field_type = 4
Update Field type and/or type options.
enable_field = 5
Enables Field.
disable_field = 6
Disables Field.
delete_field = 7
Deletes a Field from the label.
create_selection_choice = 8
Creates a new selection list option to add to a Selection Field.
update_selection_choice_properties = 9
Updates a Choice within a Selection Field.
enable_selection_choice = 10
Enables a Choice within a Selection Field.
disable_selection_choice = 11
Disables a Choice within a Selection Field.
delete_selection_choice = 12
Deletes a Choice from a Selection Field.
message
requests.proto:409Response following update to Field properties.
Used in:
int32 priority = 1
The priority of the updated field. The priority may change from what was specified to assure contiguous priorities between fields (1-n).
message
requests.proto:416Response following update to Field type.
Used in:
(message has no fields)
message
requests.proto:395Response following update to Label properties.
Used in:
(message has no fields)
message
requests.proto:437Response following update to Selection Choice properties.
Used in:
int32 priority = 1
The priority of the updated choice. The priority may change from what was specified to assure contiguous priorities between choices (1-n).
message
exception_detail.proto:112Exception detail.
ExceptionType error_type = 1
The type of exception that occurred. Required.
Every ExceptionType maps to one and only one Exception class. This allows internal clients to identify the exact server exception that caused the error for debugging and logging purposes. Add new ExceptionTypes to EXCEPTION_TYPE_TO_ERROR_CODE_MAP in j/c/g/apps/boq/metadata/model/service/exceptions/CategoryExceptionHelper
Used in:
EXCEPTION_TYPE_UNSPECIFIED = 0
Unknown ExceptionType.
FIELD_REQUIRED = 1
The required field is missing.
METAMODEL_ALREADY_EXISTS = 2
Unable to create a metamodel with the given ID because it already exists.
METAMODEL_NOT_FOUND = 3
Metamodel was not found
ILLEGAL_METAMODEL_STATE_TRANSITION = 4
Metamodel state transition isn't allowed.
INVALID_METAMODEL_DEPRECATION_POLICY = 5
Metamodel deprecation policy is invalid.
METAMODEL_DELETION_DENIED_UNTIL = 6
Cannot delete a metamodel due to the pending deprecation policy.
INVALID_FIELD = 7
A Field value is invalid.
METAMODEL_PRECONDITION_FAILED = 8
Precondition failed when updating a metamodel
DUPLICATE_FIELD_KEY = 9
Multiple fields had the same key.
ILLEGAL_FIELD_REMOVAL = 10
Removing a field from a Metamodel (e.g. a published Metamodel) is not permitted.
ILLEGAL_FIELD_OPTIONS_FOR_FIELD = 11
Cannot specify field options for a different field type.
UNSUPPORTED_CHANGE_TO_PUBLISHED_METAMODEL = 12
Some changes are not supported
ILLEGAL_METAMODEL_STATE_TRANSITION_IN_UPDATE = 13
Cannot change the metamodel state in an update
PAGE_TOKEN_EXPIRED = 14
The page token is expired
NOT_AUTHORIZED = 15
The user is not authorized to make the request.
ILLEGAL_FIELD_STATE_TRANSITION = 16
Illegal field state transition
ILLEGAL_CHOICE_SET_OPTION_STATE_TRANSITION = 17
Illegal choice set option state transition
INVALID_CHOICE_SET_OPTIONS = 18
Invalid choice set options
INVALID_FIELD_KEY = 19
Invalid field key
INVALID_FIELD_PROPERTY_RANGE = 20
A specified property on a field is outside the allowed range.
INVALID_LOCALIZED_STRING = 21
A localized string wasn't valid. This may be because the locale is invalid, its missing a default value, or the translation is empty for a set locale.
ILLEGAL_CHANGE_TO_PUBLISHED_FIELD = 22
cannot change a property on a published field
INVALID_FIELD_UPDATE_NOT_INCLUSIVE = 23
A field update is not inclusive of the previous value
INVALID_CHOICE_SET_STATE = 24
A field update is not inclusive of the previous value
INTERNAL_SERVER_ERROR = 500
An unknown error occurred
message
field.proto:33Defines 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.
Used in: ,
oneof type
The data type and options of this field. Once published, the data type cannot be changed.
text_options = 16
Text field options.
integer_options = 18
Integer field options.
date_options = 19
Date field options.
selection_options = 20
Selection field options.
user_options = 21
User field options.
string id = 1
Output only. The key of a field, unique within a label or library. This value is autogenerated. Matches the regex: `([a-zA-Z0-9])+`
string query_key = 2
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".
optional properties = 3
The basic properties of the field.
optional lifecycle = 4
Output only. The lifecycle of this field.
optional display_hints = 5
Output only. UI display hints for rendering a field.
optional schema_capabilities = 6
Output only. The capabilities this user has when editing this field.
optional applied_capabilities = 7
Output only. The capabilities this user has on this field and its value when the label is applied on Drive items.
optional creator = 8
Output only. The user who created this field.
optional create_time = 9
Output only. The time this field was created.
optional updater = 10
Output only. The user who modified this field.
optional update_time = 11
Output only. The time this field was updated.
optional publisher = 12
Output only. The user who published this field. This value has no meaning when the field is not published.
optional disabler = 13
Output only. The user who disabled this field. This value has no meaning when the field is not disabled.
optional disable_time = 14
Output only. The time this field was disabled. This value has no meaning when the field is not disabled.
optional lock_status = 15
Output only. The LockStatus of this field.
message
field.proto:84The capabilities related to this field on applied metadata.
Used in:
bool can_read = 1
Whether the user can read related applied metadata on items.
bool can_search = 2
Whether the user can search for Drive items referencing this field.
bool can_write = 3
Whether the user can set this field on Drive items.
message
field.proto:120Options for the date field type.
Used in: ,
DateOptions.DateFormat date_format_type = 1
Localized date formatting option. Field values are rendered in this format according to their locale.
string date_format = 2
Output only. ICU date format.
optional min_value = 3
Output only. Minimum valid value (year, month, day).
optional max_value = 4
Output only. Maximum valid value (year, month, day).
Localized date format options.
Used in:
DATE_FORMAT_UNSPECIFIED = 0
Date format unspecified.
LONG_DATE = 1
Includes full month name. For example, January 12, 1999 (MMMM d, y)
SHORT_DATE = 2
Short, numeric, representation. For example, 12/13/99 (M/d/yy)
message
field.proto:48UI display hints for rendering a field.
Used in:
bool required = 1
Whether the field should be shown as required in the UI.
bool disabled = 2
Whether the field should be shown in the UI as disabled.
bool hidden_in_search = 3
This field should be hidden in the search menu when searching for Drive items.
bool shown_in_apply = 4
This field should be shown in the apply menu when applying values to a Drive item.
message
field.proto:111Options for the Integer field type.
Used in: ,
int64 min_value = 1
Output only. The minimum valid value for the integer field.
int64 max_value = 2
Output only. The maximum valid value for the integer field.
message
field.proto:96Options for a multi-valued variant of an associated field type.
Used in: ,
int32 max_entries = 1
Maximum number of entries permitted.
message
field.proto:35The basic properties of the field.
Used in: ,
string display_name = 1
Required. The display text to show in the UI identifying this field.
bool required = 2
Whether the field should be marked as required.
string insert_before_field = 3
Input only. Insert or move this field before the indicated field. If empty, the field is placed at the end of the list.
message
field.proto:65The capabilities related to this field when editing the field.
Used in:
bool can_update = 1
Whether the user can change this field.
bool can_delete = 2
Whether the user can delete this field. The user must have permission and the field must be deprecated.
bool can_disable = 3
Whether the user can disable this field. The user must have permission and this field must not already be disabled.
bool can_enable = 4
Whether the user can enable this field. The user must have permission and this field must be disabled.
message
field.proto:152Options for the selection field type.
Used in: ,
optional list_options = 1
When specified, indicates this field supports a list of values. Once the field is published, this cannot be changed.
repeated choices = 2
The options available for this selection field. The list order is consistent, and modified with `insert_before_choice`.
message
field.proto:154Selection field choice.
Used in: ,
string id = 1
The unique value of the choice. This ID is autogenerated. Matches the regex: `([a-zA-Z0-9_])+`.
optional properties = 2
Basic properties of the choice.
optional lifecycle = 3
Output only. Lifecycle of the choice.
optional display_hints = 4
Output only. UI display hints for rendering a choice.
optional schema_capabilities = 5
Output only. The capabilities related to this option when editing the option.
optional applied_capabilities = 6
Output only. The capabilities related to this choice on applied metadata.
optional creator = 7
Output only. The user who created this choice.
optional create_time = 8
Output only. The time this choice was created.
optional updater = 9
Output only. The user who updated this choice last.
optional update_time = 10
Output only. The time this choice was updated last.
optional publisher = 11
Output only. The user who published this choice. This value has no meaning when the choice is not published.
optional publish_time = 12
Output only. The time this choice was published. This value has no meaning when the choice is not published.
optional disabler = 13
Output only. The user who disabled this choice. This value has no meaning when the option is not disabled.
optional disable_time = 14
Output only. The time this choice was disabled. This value has no meaning when the choice is not disabled.
optional lock_status = 15
Output only. The LockStatus of this choice.
message
field.proto:219The capabilities related to this choice on applied metadata.
Used in:
bool can_read = 1
Whether the user can read related applied metadata on items.
bool can_search = 2
Whether the user can use this choice in search queries.
bool can_select = 3
Whether the user can select this choice on an item.
message
field.proto:174UI display hints for rendering an option.
Used in:
bool disabled = 1
Whether the option should be shown in the UI as disabled.
bool hidden_in_search = 2
This option should be hidden in the search menu when searching for Drive items.
bool shown_in_apply = 3
This option should be shown in the apply menu when applying values to a Drive item.
optional badge_colors = 4
The colors to use for the badge. Changed to Google Material colors based on the chosen `properties.badge_config.color`.
optional dark_badge_colors = 5
The dark-mode color to use for the badge. Changed to Google Material colors based on the chosen `properties.badge_config.color`.
int64 badge_priority = 6
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.
message
field.proto:156Basic properties of the choice.
Used in: ,
string display_name = 1
Required. The display text to show in the UI identifying this field.
string description = 2
The description of this label.
optional badge_config = 3
The badge configuration for this choice. When set, the label that owns this choice is considered a "badged label".
string insert_before_choice = 4
Input only. Insert or move this choice before the indicated choice. If empty, the choice is placed at the end of the list.
message
field.proto:204The capabilities related to this choice when editing the choice.
Used in:
bool can_update = 1
Whether the user can update this choice.
bool can_delete = 2
Whether the user can delete this choice.
bool can_disable = 3
Whether the user can disable this choice.
bool can_enable = 4
Whether the user can enable this choice.
message
field.proto:102Options for the Text field type.
Used in: ,
int32 min_length = 1
Output only. The minimum valid length of values for the text field.
int32 max_length = 2
Output only. The maximum valid length of values for the text field.
message
field.proto:300Options for the user field type.
Used in: ,
optional list_options = 1
When specified, indicates that this field supports a list of values. Once the field is published, this cannot be changed.
message
label_limits.proto:61Field constants governing the structure of a Field; such as, the maximum title length, minimum and maximum field values or length, etc.
Used in:
int32 max_id_length = 1
Max length for the id.
int32 max_display_name_length = 2
Limits for Field title.
int32 max_description_length = 3
Limits for Field description, also called help text.
optional text_limits = 4
The relevant limits for the specified Field.Type. Text Field limits.
optional long_text_limits = 5
Long text Field limits.
optional integer_limits = 6
Integer Field limits.
optional date_limits = 7
Date Field limits.
optional user_limits = 8
User Field limits.
optional selection_limits = 9
Selection Field limits.
message
label_limits.proto:116Limits for integer Field type.
Used in:
int64 min_value = 1
Minimum value for an integer Field type.
int64 max_value = 2
Maximum value for an integer Field type.
message
error_details.proto:26Describes violations in a request to create or update a Label or its Fields.
repeated field_violations = 1
Describes all violations in a client request.
message
error_details.proto:28Describes the Field in which the violation occurred.
Used in:
string field = 1
The path to the field where this violation occurred. This path is specified using `FieldMask` format: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
FieldViolation.Reason reason = 2
The detailed reason for this FieldViolation.
string display_message = 3
A message that describes the violation. This message is intended to be shown to end users, and is localized into the requesting user's preferred language.
Possible reasons a field is invalid.
Used in:
REASON_UNSPECIFIED = 0
Unknown reason.
FIELD_REQUIRED = 1
The referenced field is required.
INVALID_VALUE = 2
The referenced value was invalid.
VALUE_OUT_OF_RANGE = 3
The specified numeric value is out of the allowed range.
STRING_VALUE_TOO_LONG = 4
The specified string value was too long.
MAX_ENTRIES_EXCEEDED = 5
The number of entries exceeded the maximum.
FIELD_NOT_FOUND = 6
The specified field is not found in the Label.
CHOICE_NOT_FOUND = 7
The specified choice is not found in the Field.
message
label.proto:39A 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.
Used as response type in: LabelService.CreateLabel, LabelService.DisableLabel, LabelService.EnableLabel, LabelService.GetLabel, LabelService.PublishLabel, LabelService.UpdateLabelCopyMode
Used as field type in: , ,
string name = 1
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.
string id = 2
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])+`
string revision_id = 3
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])+`
Label.LabelType label_type = 4
Required. The type of label.
optional creator = 5
Output only. The user who created this label.
optional create_time = 6
Output only. The time this label was created.
optional revision_creator = 7
Output only. The user who created this label revision.
optional revision_create_time = 8
Output only. The time this label revision was created.
optional publisher = 9
Output only. The user who published this label. This value has no meaning when the label is not published.
optional publish_time = 10
Output only. The time this label was published. This value has no meaning when the label is not published.
optional disabler = 11
Output only. The user who disabled this label. This value has no meaning when the label is not disabled.
optional disable_time = 12
Output only. The time this label was disabled. This value has no meaning when the label is not disabled.
string customer = 13
Output only. The customer this label belongs to. For example: "customers/123abc789."
optional properties = 14
Required. The basic properties of the label.
optional lifecycle = 15
Output only. The lifecycle state of the label including whether it's published, deprecated, and has draft changes.
optional display_hints = 16
Output only. UI display hints for rendering the label.
optional applied_capabilities = 17
Output only. The capabilities related to this label on applied metadata.
optional schema_capabilities = 18
Output only. The capabilities the user has on this label.
optional applied_label_policy = 19
Output only. Behavior of this label when it's applied to Drive items.
repeated fields = 20
List of fields in descending priority order.
string learn_more_uri = 21
Custom URL to present to users to allow them to learn more about this label and how it should be used.
optional lock_status = 22
Output only. The LockStatus of this label.
message
label.proto:72The capabilities a user has on this label's applied metadata.
Used in:
bool can_read = 1
Whether the user can read applied metadata related to this label.
bool can_apply = 2
Whether the user can apply this label to items.
bool can_remove = 3
Whether the user can remove this label from items.
message
label.proto:103Behavior of this label when it's applied to Drive items.
Used in:
AppliedLabelPolicy.CopyMode copy_mode = 1
Indicates how the applied label and field values should be copied when a Drive item is copied.
Indicates how the applied label and field values should be copied when a Drive item is copied.
Used in: ,
COPY_MODE_UNSPECIFIED = 0
Copy mode unspecified.
DO_NOT_COPY = 1
The applied label and field values are not copied by default when the Drive item it's applied to is copied.
ALWAYS_COPY = 2
The applied label and field values are always copied when the Drive item it's applied to is copied. Only admins can use this mode.
COPY_APPLIABLE = 3
The applied label and field values are copied if the label is appliable by the user making the copy.
message
label.proto:55UI display hints for rendering the label.
Used in:
bool disabled = 1
Whether the label should be shown in the UI as disabled.
bool hidden_in_search = 2
This label should be hidden in the search menu when searching for Drive items.
bool shown_in_apply = 3
This label should be shown in the apply menu when applying values to a Drive item.
int64 priority = 4
Order to display label in a list.
The type of this label.
Used in:
LABEL_TYPE_UNSPECIFIED = 0
Unknown label type.
SHARED = 1
Shared labels may be shared with users to apply to Drive items.
ADMIN = 2
Admin-owned label. Only creatable and editable by admins. Supports some additional admin-only features.
GOOGLE_APP = 3
A label owned by an internal Google application rather than a customer. These labels are read-only.
message
label.proto:46Basic properties of the label.
Used in: ,
string title = 1
Required. Title of the label.
string description = 2
The description of the label.
message
label.proto:84The capabilities related to this label when editing the label.
Used in:
bool can_update = 1
Whether the user can change this label.
bool can_delete = 2
Whether the user can delete this label. The user must have permission and the label must be disabled.
bool can_disable = 3
Whether the user can disable this label. The user must have permission and this label must not already be disabled.
bool can_enable = 4
Whether the user can enable this label. The user must have permission and this label must be disabled.
message
label_lock.proto:31A Lock that can be applied to a Label, Field, or Choice.
Used in:
string name = 1
Output only. Resource name of this LabelLock.
string field_id = 2
The ID of the Field that should be locked. Empty if the whole Label should be locked.
string choice_id = 3
The ID of the Selection Field Choice that should be locked. If present, `field_id` must also be present.
optional create_time = 4
Output only. The time this LabelLock was created.
optional creator = 5
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.
optional delete_time = 6
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.
optional capabilities = 8
Output only. The user's capabilities on this LabelLock.
LabelLock.State state = 9
Output only. This LabelLock's state.
message
label_lock.proto:38A description of a user's capabilities on a LabelLock.
Used in:
bool can_view_policy = 1
True if the user is authorized to view the policy.
A description of a LabelLock's state.
Used in:
STATE_UNSPECIFIED = 0
Unknown state.
ACTIVE = 1
The LabelLock is active and is being enforced by the server.
DELETING = 2
The LabelLock is being deleted. The LabelLock will continue to be enforced by the server until it has been fully removed.
message
label_permission.proto:33The permission that applies to a principal (user, group, audience) on a label.
Used as response type in: LabelService.CreateLabelPermission, LabelService.UpdateLabelPermission
Used as field type in: , , ,
oneof principal
The principal this permission applies to. Must be either an email, user, group, or audience. Example: * people/12345 * groups/45678 * audiences/default
string person = 3
Person resource name.
string group = 4
Group resource name.
string audience = 5
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.
string name = 1
Resource name of this permission.
string email = 2
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.
LabelPermission.LabelRole role = 6
The role the principal should have.
Roles are concentric with subsequent role.
Used in: ,
LABEL_ROLE_UNSPECIFIED = 0
Unknown role.
READER = 1
A reader can read the label and associated metadata applied to Drive items.
APPLIER = 2
An applier can write associated metadata on Drive items in which they also have write access to. Implies `READER`.
ORGANIZER = 3
An organizer can pin this label in shared drives they manage and add new appliers to the label.
EDITOR = 4
Editors can make any update including deleting the label which also deletes the associated Drive item metadata. Implies `APPLIER`.
Resource view that can be applied to label responses. The default value `LABEL_VIEW_BASIC` implies the field mask: `name,id,revision_id,label_type,properties.*`\
Used in: , , ,
LABEL_VIEW_BASIC = 0
Implies the field mask: `name,id,revision_id,label_type,properties.*`
LABEL_VIEW_FULL = 1
All possible fields.
message
common.proto:51The 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.
Used in: , ,
Lifecycle.State state = 1
Output only. The state of the object associated with this lifecycle.
bool has_unpublished_changes = 2
Output only. Whether the object associated with this lifecycle has unpublished changes.
optional disabled_policy = 3
The policy that governs how to show a disabled label, field, or selection choice.
message
common.proto:54The policy that governs how to treat a disabled label, field, or selection choice in different contexts.
Used in: , , ,
bool hide_in_search = 1
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.
bool show_in_apply = 2
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.
The state of the object associated with this lifecycle.
Used in:
STATE_UNSPECIFIED = 0
Unknown State.
UNPUBLISHED_DRAFT = 1
The initial state of an object. Once published, the object can never return to this state. Once an object is published, certain kinds of changes are no longer permitted.
PUBLISHED = 2
The object has been published. The object might have unpublished draft changes as indicated by `has_unpublished_changes`.
DISABLED = 3
The object has been published and has since been disabled. The object might have unpublished draft changes as indicated by `has_unpublished_changes`.
DELETED = 4
The object has been deleted.
message
label_limits.proto:92Limits for list-variant of a Field type.
Used in: ,
int32 max_entries = 1
Maximum number of values allowed for the Field type.
message
common.proto:145Contains information about whether a label component should be considered locked.
Used in: , ,
bool locked = 1
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.
message
label_limits.proto:107Limits for long text Field type.
Used in:
int32 min_length = 1
Minimum length allowed for a long text Field type.
int32 max_length = 2
Maximum length allowed for a long text Field type.
message
error_details.proto:75Describes what preconditions have failed.
repeated violation = 1
Describes all violations in a client request.
message
error_details.proto:77Specific failure reason.
Used in:
string field = 1
The path to the field where this violation occurred. This path is specified using `FieldMask` format: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
Violation.Reason reason = 2
The type of this violation.
string display_message = 3
A message that describes the violation. This message is intended to be shown to end users, and is localized into the requesting user's preferred language.
The possible reasons a the violation occurred.
Used in:
REASON_UNSPECIFIED = 0
Unknown violation type.
CANNOT_DISABLE = 1
This Resource cannot be Disabled. Only Published resources can be Disabled.
CANNOT_ENABLE = 2
This Resource cannot be Enabled. Only Disabled resources can be Enabled.
CANNOT_PUBLISH = 3
This Resource cannot be Published. Only Draft or Disabled resources can be Published.
CANNOT_UNPUBLISH = 4
This Resource cannot be Unpublished. Once published, resources may not be set in "Draft" state.
CANNOT_DELETE = 5
This Resource cannot be Deleted. Only Disabled resources can be Deleted.
CANNOT_RESTRICT_RANGE = 6
The request modified a range in a Field, but the new range does not include the previous range. When this error happens, `field` points at the Field where the violation occurred.
CANNOT_CHANGE_PUBLISHED_FIELD = 7
The specified change cannot be made to published Resources.
CANNOT_CREATE_MORE_LABELS = 8
The customer cannot create new labels because the maximum number of labels for the customer has been reached.
CANNOT_CHANGE_PUBLISHED_FIELD_TYPE = 9
The Field type cannot be changed because the Field has been published.
CANNOT_MODIFY_LOCKED_COMPONENT = 10
The Label component is locked and cannot be deleted
UNSUPPORT_ENABLED_APP_SETTINGS = 11
The Label cannot be enabled in the target application or applications.
message
label_limits.proto:134Limits for selection Field type.
Used in:
optional list_limits = 1
Limits for list-variant of a Field type.
int32 max_id_length = 2
Maximum ID length for a selection options.
int32 max_display_name_length = 3
Maximum length for display name.
int32 max_choices = 4
The max number of choices.
int32 max_deleted_choices = 5
Maximum number of deleted choices.
message
label_limits.proto:98Limits for text Field type.
Used in:
int32 min_length = 1
Minimum length allowed for a text Field type.
int32 max_length = 2
Maximum length allowed for a text Field type.
message
requests.proto:609Updates a Label Permission. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.
Used as request type in: LabelService.UpdateLabelPermission
Used as field type in:
string parent = 1
Required. The parent Label resource name.
optional label_permission = 2
Required. The permission to create or update on the Label.
bool use_admin_access = 3
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.
message
common.proto:107Information about a user.
Used in: , , ,
string person = 1
The identifier for this user that can be used with the People API to get more information. For example, people/12345678.
message
label_limits.proto:152Limits for Field.Type.USER.
Used in:
optional list_limits = 1
Limits for list-variant of a Field type.
message
requests.proto:48Provides control over how write requests are executed. When not specified, the last write wins.
Used in: , , , ,
oneof control
Determines the revision of the label to write to and how the request should behave if that revision is not the current revision of the label.
string required_revision_id = 1
The [revision_id][google.apps.drive.labels.v1.Label.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.