docs/dyn/content_v2_1.accounts.businessmessageslinks.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.accounts.html">accounts</a> . <a href="content_v2_1.accounts.businessmessageslinks.html">businessmessageslinks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a `BusinessMessagesLink` in Merchant Center account.</p>
<p class="toc_element">
  <code><a href="#delete">delete(accountId, businessMessagesLinkId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified `BusinessMessagesLink` resource from Merchant Center account.</p>
<p class="toc_element">
  <code><a href="#get">get(accountId, businessMessagesLinkId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves `BusinessMessagesLink` in Merchant Center account.</p>
<p class="toc_element">
  <code><a href="#list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the `BusinessMessagesLink` resources for Merchant Center account.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(accountId, body=None, x__xgafv=None)</code>
  <pre>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.
  &quot;agentId&quot;: &quot;A String&quot;, # 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).
  &quot;businessMessagesLinkId&quot;: &quot;A String&quot;, # 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.
  &quot;agentId&quot;: &quot;A String&quot;, # 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).
  &quot;businessMessagesLinkId&quot;: &quot;A String&quot;, # Output only. Immutable. The ID uniquely identifying each `BusinessMessagesLink`.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(accountId, businessMessagesLinkId, x__xgafv=None)</code>
  <pre>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
</pre>
</div>

<div class="method">
    <code class="details" id="get">get(accountId, businessMessagesLinkId, x__xgafv=None)</code>
  <pre>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.
  &quot;agentId&quot;: &quot;A String&quot;, # 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).
  &quot;businessMessagesLinkId&quot;: &quot;A String&quot;, # Output only. Immutable. The ID uniquely identifying each `BusinessMessagesLink`.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>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.
  &quot;businessMessagesLinks&quot;: [ # 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.
      &quot;agentId&quot;: &quot;A String&quot;, # 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).
      &quot;businessMessagesLinkId&quot;: &quot;A String&quot;, # Output only. Immutable. The ID uniquely identifying each `BusinessMessagesLink`.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>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 &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>