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.customerLabels

Resource: CustomerLabel

Represents a relationship between a customer and a label. This customer may not have access to all the labels attached to it. Additional CustomerLabels may be returned by increasing permissions with login-customer-id.

JSON representation
{
  "resourceName": string,
  "customer": string,
  "label": string
}
Fields
resourceName

string

Immutable. Name of the resource. Customer label resource names have the form: customers/{customerId}/customerLabels/{label_id}

customer

string

Output only. The resource name of the customer to which the label is attached. Read only.

label

string

Output only. The resource name of the label assigned to the customer.

Note: the Customer ID portion of the label resource name is not validated when creating a new CustomerLabel.

Methods

get

Returns the requested customer-label relationship in full detail.

mutate

Creates and removes customer-label relationships.