Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.labels

Resource: Label

A label.

JSON representation
{
  "resourceName": string,
  "status": enum (LabelStatus),
  "textLabel": {
    object (TextLabel)
  },
  "id": string,
  "name": string
}
Fields
resourceName

string

Immutable. Name of the resource. Label resource names have the form: customers/{customerId}/labels/{label_id}

status

enum (LabelStatus)

Output only. Status of the label. Read only.

textLabel

object (TextLabel)

A type of label displaying text on a colored background.

id

string (int64 format)

Output only. Id of the label. Read only.

name

string

The name of the label.

This field is required and should not be empty when creating a new label.

The length of this string should be between 1 and 80, inclusive.

LabelStatus

Possible statuses of a label.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Label is enabled.
REMOVED Label is removed.

TextLabel

A type of label displaying text on a colored background.

JSON representation
{
  "backgroundColor": string,
  "description": string
}
Fields
backgroundColor

string

Background color of the label in RGB format. This string must match the regular expression '^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.

description

string

A short description of the label. The length must be no more than 200 characters.

Methods

get

Returns the requested label in full detail.

mutate

Creates, updates, or removes labels.