Content API for Shopping . accounts . labels

close()

Close httplib2 connections.

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

Creates a new label, not assigned to any account.

Args:
  accountId: string, Required. The id of the account this label belongs to. (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", # Immutable. The ID of account this label belongs to.
  "description": "A String", # The description 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 display name of this 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", # Immutable. The ID of account this label belongs to.
  "description": "A String", # The description 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 display name of this label.
}

delete(accountId, labelId, x__xgafv=None)

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

Args:
  accountId: string, Required. The id of the account that owns the label. (required)
  labelId: string, Required. The id of the label to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

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

Lists the labels assigned to an account.

Args:
  accountId: string, Required. The account id for whose labels are to be listed. (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", # Immutable. The ID of account this label belongs to.
      "description": "A String", # The description 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 display name of this 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(previous_request, previous_response)

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(accountId, labelId, body=None, x__xgafv=None)

Updates a label.

Args:
  accountId: string, Required. The id of the account this label belongs to. (required)
  labelId: string, Required. The id of the label to update. (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", # Immutable. The ID of account this label belongs to.
  "description": "A String", # The description 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 display name of this 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", # Immutable. The ID of account this label belongs to.
  "description": "A String", # The description 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 display name of this label.
}