CSS API . accounts . labels

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a new label, not assigned to any account.

Args:
  parent: string, Required. The parent account. Format: accounts/{account} (required)
  body: object, The request body.
    The object takes the form of:

{ # Label assigned by CSS domain or CSS group to one of its sub-accounts.
  "accountId": "A String", # Output only. The ID of account this label belongs to.
  "description": "A String", # The description of this label.
  "displayName": "A String", # The display name of this label.
  "labelId": "A String", # Output only. The ID of the label.
  "labelType": "A String", # Output only. The type of this label.
  "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
  "accountId": "A String", # Output only. The ID of account this label belongs to.
  "description": "A String", # The description of this label.
  "displayName": "A String", # The display name of this label.
  "labelId": "A String", # Output only. The ID of the label.
  "labelType": "A String", # Output only. The type of this label.
  "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
}

delete(name, x__xgafv=None)

Deletes a label and removes it from all accounts to which it was assigned.

Args:
  name: string, Required. The name of the label to delete. Format: accounts/{account}/labels/{label} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists the labels owned by an account.

Args:
  parent: string, Required. The parent account. Format: accounts/{account} (required)
  pageSize: integer, The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the `ListAccountLabels` method.
  "accountLabels": [ # The labels from the specified account.
    { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
      "accountId": "A String", # Output only. The ID of account this label belongs to.
      "description": "A String", # The description of this label.
      "displayName": "A String", # The display name of this label.
      "labelId": "A String", # Output only. The ID of the label.
      "labelType": "A String", # Output only. The type of this label.
      "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

patch(name, body=None, x__xgafv=None)

Updates a label.

Args:
  name: string, The resource name of the label. Format: accounts/{account}/labels/{label} (required)
  body: object, The request body.
    The object takes the form of:

{ # Label assigned by CSS domain or CSS group to one of its sub-accounts.
  "accountId": "A String", # Output only. The ID of account this label belongs to.
  "description": "A String", # The description of this label.
  "displayName": "A String", # The display name of this label.
  "labelId": "A String", # Output only. The ID of the label.
  "labelType": "A String", # Output only. The type of this label.
  "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
  "accountId": "A String", # Output only. The ID of account this label belongs to.
  "description": "A String", # The description of this label.
  "displayName": "A String", # The display name of this label.
  "labelId": "A String", # Output only. The ID of the label.
  "labelType": "A String", # Output only. The type of this label.
  "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
}