Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13178889.9 KB
labels

Creates a label. For more information, see Create and publish a label.

post/v2/labels

Query parameters

languageCodestring

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.

useAdminAccessboolean

Set to true in order to use the user's admin privileges. The server will verify the user is an admin before allowing access.

Request body

revisionIdstring

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])+.

revisionCreateTimestring google-datetime

Output only. The time this label revision was created.

customerstring

Output only. The customer this label belongs to. For example: customers/123abc789.

createTimestring google-datetime

Output only. The time this label was created.

learnMoreUristring

Custom URL to present to users to allow them to learn more about this label and how it should be used.

namestring

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.

labelType'LABEL_TYPE_UNSPECIFIED' | 'SHARED' | 'ADMIN' | 'GOOGLE_APP'

Required. The type of label.

publishTimestring google-datetime

Output only. The time this label was published. This value has no meaning when the label isn't published.

disableTimestring google-datetime

Output only. The time this label was disabled. This value has no meaning when the label isn't disabled.

idstring

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])+.

Response

Successful response