docs/dyn/adsense_v2.accounts.adclients.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="adsense_v2.html">AdSense Management API</a> . <a href="adsense_v2.accounts.html">accounts</a> . <a href="adsense_v2.accounts.adclients.html">adclients</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="adsense_v2.accounts.adclients.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits Resource.</p>

<p class="toc_element">
  <code><a href="adsense_v2.accounts.adclients.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels Resource.</p>

<p class="toc_element">
  <code><a href="adsense_v2.accounts.adclients.urlchannels.html">urlchannels()</a></code>
</p>
<p class="firstline">Returns the urlchannels Resource.</p>

<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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the ad client from the given resource name.</p>
<p class="toc_element">
  <code><a href="#getAdcode">getAdcode(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the AdSense code for a given ad client. This returns what was previously known as the 'auto ad code'. This is only supported for ad clients with a product_code of AFC. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the ad clients available in an 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="get">get(name, x__xgafv=None)</code>
  <pre>Gets the ad client from the given resource name.

Args:
  name: string, Required. The name of the ad client to retrieve. Format: accounts/{account}/adclients/{adclient} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Representation of an ad client. An ad client represents a user&#x27;s subscription with a specific AdSense product.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the ad client. Format: accounts/{account}/adclients/{adclient}
  &quot;productCode&quot;: &quot;A String&quot;, # Output only. Reporting product code of the ad client. For example, &quot;AFC&quot; for AdSense for Content. Corresponds to the `PRODUCT_CODE` dimension, and present only if the ad client supports reporting.
  &quot;reportingDimensionId&quot;: &quot;A String&quot;, # Output only. Unique ID of the ad client as used in the `AD_CLIENT_ID` reporting dimension. Present only if the ad client supports reporting.
  &quot;state&quot;: &quot;A String&quot;, # Output only. State of the ad client.
}</pre>
</div>

<div class="method">
    <code class="details" id="getAdcode">getAdcode(name, x__xgafv=None)</code>
  <pre>Gets the AdSense code for a given ad client. This returns what was previously known as the &#x27;auto ad code&#x27;. This is only supported for ad clients with a product_code of AFC. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).

Args:
  name: string, Required. Name of the ad client for which to get the adcode. Format: accounts/{account}/adclients/{adclient} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Representation of the AdSense code for a given ad client. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).
  &quot;adCode&quot;: &quot;A String&quot;, # Output only. The AdSense code snippet to add to the head of an HTML page.
  &quot;ampBody&quot;: &quot;A String&quot;, # Output only. The AdSense code snippet to add to the body of an AMP page.
  &quot;ampHead&quot;: &quot;A String&quot;, # Output only. The AdSense code snippet to add to the head of an AMP page.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists all the ad clients available in an account.

Args:
  parent: string, Required. The account which owns the collection of ad clients. Format: accounts/{account} (required)
  pageSize: integer, The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
  pageToken: string, A page token, received from a previous `ListAdClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdClients` 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 definition for the ad client list rpc.
  &quot;adClients&quot;: [ # The ad clients returned in this list response.
    { # Representation of an ad client. An ad client represents a user&#x27;s subscription with a specific AdSense product.
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the ad client. Format: accounts/{account}/adclients/{adclient}
      &quot;productCode&quot;: &quot;A String&quot;, # Output only. Reporting product code of the ad client. For example, &quot;AFC&quot; for AdSense for Content. Corresponds to the `PRODUCT_CODE` dimension, and present only if the ad client supports reporting.
      &quot;reportingDimensionId&quot;: &quot;A String&quot;, # Output only. Unique ID of the ad client as used in the `AD_CLIENT_ID` reporting dimension. Present only if the ad client supports reporting.
      &quot;state&quot;: &quot;A String&quot;, # Output only. State of the ad client.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through ad clients. To retrieve the next page of the results, set the next request&#x27;s &quot;page_token&quot; value to this.
}</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>