Content API for Shopping . accounts . businessmessageslinks

Instance Methods

close()

Close httplib2 connections.

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

Creates a `BusinessMessagesLink` in Merchant Center account.

delete(accountId, businessMessagesLinkId, x__xgafv=None)

Deletes the specified `BusinessMessagesLink` resource from Merchant Center account.

get(accountId, businessMessagesLinkId, x__xgafv=None)

Retrieves `BusinessMessagesLink` in Merchant Center account.

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

Lists the `BusinessMessagesLink` resources for Merchant Center account.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
create(accountId, body=None, x__xgafv=None)
Creates a `BusinessMessagesLink` in Merchant Center account.

Args:
  accountId: string, Required. The ID of the Merchant Center account. (required)
  body: object, The request body.
    The object takes the form of:

{ # A Link from a [Business Messages](https://businessmessages.google) Agent Id to the Merchant Center account. You can create multiple `BusinessMessagesLink` to Merchant Center Account. Only available to selected merchants. See [Create agents to manage brands](https://developers.google.com/business-communications/business-messages/guides/how-to/agents) for more information.
  "agentId": "A String", # Required. Agent ID from Business Messages to link to the Merchant Center account. The Agent ID can be found in the [Business Communications Developer Console](https://developers.google.com/business-communications/business-messages/guides/concepts/developer-console#agent_selection).
  "businessMessagesLinkId": "A String", # Output only. Immutable. The ID uniquely identifying each `BusinessMessagesLink`.
}

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

Returns:
  An object of the form:

    { # A Link from a [Business Messages](https://businessmessages.google) Agent Id to the Merchant Center account. You can create multiple `BusinessMessagesLink` to Merchant Center Account. Only available to selected merchants. See [Create agents to manage brands](https://developers.google.com/business-communications/business-messages/guides/how-to/agents) for more information.
  "agentId": "A String", # Required. Agent ID from Business Messages to link to the Merchant Center account. The Agent ID can be found in the [Business Communications Developer Console](https://developers.google.com/business-communications/business-messages/guides/concepts/developer-console#agent_selection).
  "businessMessagesLinkId": "A String", # Output only. Immutable. The ID uniquely identifying each `BusinessMessagesLink`.
}
delete(accountId, businessMessagesLinkId, x__xgafv=None)
Deletes the specified `BusinessMessagesLink` resource from Merchant Center account.

Args:
  accountId: string, Required. The ID of the Merchant Center account. (required)
  businessMessagesLinkId: string, Required. The identifier for the Business Messages Link. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(accountId, businessMessagesLinkId, x__xgafv=None)
Retrieves `BusinessMessagesLink` in Merchant Center account.

Args:
  accountId: string, Required. The ID of the Merchant Center account. (required)
  businessMessagesLinkId: string, Required. The identifier for the Business Messages Link. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Link from a [Business Messages](https://businessmessages.google) Agent Id to the Merchant Center account. You can create multiple `BusinessMessagesLink` to Merchant Center Account. Only available to selected merchants. See [Create agents to manage brands](https://developers.google.com/business-communications/business-messages/guides/how-to/agents) for more information.
  "agentId": "A String", # Required. Agent ID from Business Messages to link to the Merchant Center account. The Agent ID can be found in the [Business Communications Developer Console](https://developers.google.com/business-communications/business-messages/guides/concepts/developer-console#agent_selection).
  "businessMessagesLinkId": "A String", # Output only. Immutable. The ID uniquely identifying each `BusinessMessagesLink`.
}
list(accountId, pageSize=None, pageToken=None, x__xgafv=None)
Lists the `BusinessMessagesLink` resources for Merchant Center account.

Args:
  accountId: string, Required. The ID of the account. (required)
  pageSize: integer, Optional. The maximum number of `BusinessMessagesLink` resources for the Merchant Center account to return. Defaults to 50; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous `ListBusinessMessagesLinks` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListBusinessMessagesLinks` 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 `ListBusinessMessagesLinks` method.
  "businessMessagesLinks": [ # The `BusinessMessagesLink` resources for the given Merchant Center account.
    { # A Link from a [Business Messages](https://businessmessages.google) Agent Id to the Merchant Center account. You can create multiple `BusinessMessagesLink` to Merchant Center Account. Only available to selected merchants. See [Create agents to manage brands](https://developers.google.com/business-communications/business-messages/guides/how-to/agents) for more information.
      "agentId": "A String", # Required. Agent ID from Business Messages to link to the Merchant Center account. The Agent ID can be found in the [Business Communications Developer Console](https://developers.google.com/business-communications/business-messages/guides/concepts/developer-console#agent_selection).
      "businessMessagesLinkId": "A String", # Output only. Immutable. The ID uniquely identifying each `BusinessMessagesLink`.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `pageToken` 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.