blob: e158700981f40855c81988bf0ec43371ce4e0e99 [file] [log] [blame]
<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="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.accounts.html">accounts</a> . <a href="adsensehost_v4_1.accounts.adclients.html">adclients</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(accountId, adClientId)</a></code></p>
<p class="firstline">Get information about one of the ad clients in the specified publisher's AdSense account.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, maxResults=None, pageToken=None)</a></code></p>
<p class="firstline">List all hosted ad clients in the specified hosted account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, adClientId)</code>
<pre>Get information about one of the ad clients in the specified publisher&#x27;s AdSense account.
Args:
accountId: string, Account which contains the ad client. (required)
adClientId: string, Ad client to get. (required)
Returns:
An object of the form:
{
&quot;supportsReporting&quot;: True or False, # Whether this ad client supports being reported on.
&quot;arcOptIn&quot;: True or False, # Whether this ad client is opted in to ARC.
&quot;productCode&quot;: &quot;A String&quot;, # This ad client&#x27;s product code, which corresponds to the PRODUCT_CODE report dimension.
&quot;kind&quot;: &quot;adsensehost#adClient&quot;, # Kind of resource this is, in this case adsensehost#adClient.
&quot;id&quot;: &quot;A String&quot;, # Unique identifier of this ad client.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, maxResults=None, pageToken=None)</code>
<pre>List all hosted ad clients in the specified hosted account.
Args:
accountId: string, Account for which to list ad clients. (required)
maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of &quot;nextPageToken&quot; from the previous response.
Returns:
An object of the form:
{
&quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request&#x27;s &quot;pageToken&quot; value to this.
&quot;etag&quot;: &quot;A String&quot;, # ETag of this response for caching purposes.
&quot;items&quot;: [ # The ad clients returned in this list response.
{
&quot;supportsReporting&quot;: True or False, # Whether this ad client supports being reported on.
&quot;arcOptIn&quot;: True or False, # Whether this ad client is opted in to ARC.
&quot;productCode&quot;: &quot;A String&quot;, # This ad client&#x27;s product code, which corresponds to the PRODUCT_CODE report dimension.
&quot;kind&quot;: &quot;adsensehost#adClient&quot;, # Kind of resource this is, in this case adsensehost#adClient.
&quot;id&quot;: &quot;A String&quot;, # Unique identifier of this ad client.
},
],
&quot;kind&quot;: &quot;adsensehost#adClients&quot;, # Kind of list this is, in this case adsensehost#adClients.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>