Skip to main content

labels

Overview

Namelabels
TypeResource
Idgoogleworkspace.drivelabels.labels

Fields

NameDatatypeDescription
idstringOutput 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])+
namestringOutput 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.
schemaCapabilitiesobjectThe capabilities related to this label when editing the label.
learnMoreUristringCustom URL to present to users to allow them to learn more about this label and how it should be used.
fieldsarrayList of fields in descending priority order.
labelTypestringRequired. The type of label.
propertiesobjectBasic properties of the label.
createTimestringOutput only. The time this label was created.
appliedCapabilitiesobjectThe capabilities a user has on this label's applied metadata.
lifecycleobjectThe 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.
disableTimestringOutput only. The time this label was disabled. This value has no meaning when the label is not disabled.
publisherobjectInformation about a user.
appliedLabelPolicyobjectBehavior of this label when it's applied to Drive items.
revisionCreatorobjectInformation about a user.
revisionIdstringOutput 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])+
lockStatusobjectContains information about whether a label component should be considered locked.
publishTimestringOutput only. The time this label was published. This value has no meaning when the label is not published.
revisionCreateTimestringOutput only. The time this label revision was created.
disablerobjectInformation about a user.
displayHintsobjectUI display hints for rendering the label.
creatorobjectInformation about a user.

Methods

NameAccessible byRequired ParamsDescription
getSELECTlabelsIdGet 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.
listSELECTList labels.