1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
|
<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_v1_4.html">AdSense Management API</a> . <a href="adsense_v1_4.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_4.customchannels.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits 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(adClientId, customChannelId)</a></code></p>
<p class="firstline">Get the specified custom channel from the specified ad client.</p>
<p class="toc_element">
<code><a href="#list">list(adClientId, maxResults=None, pageToken=None)</a></code></p>
<p class="firstline">List all custom channels in the specified ad client for this AdSense 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="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(adClientId, customChannelId)</code>
<pre>Get the specified custom channel from the specified ad client.
Args:
adClientId: string, Ad client which contains the custom channel. (required)
customChannelId: string, Custom channel to retrieve. (required)
Returns:
An object of the form:
{
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"name": "A String", # Name of this custom channel.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"description": "A String", # The external description of the channel.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(adClientId, maxResults=None, pageToken=None)</code>
<pre>List all custom channels in the specified ad client for this AdSense account.
Args:
adClientId: string, Ad client for which to list custom channels. (required)
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
Returns:
An object of the form:
{
"etag": "A String", # ETag of this response for caching purposes.
"items": [ # The custom channels returned in this list response.
{
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"name": "A String", # Name of this custom channel.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"description": "A String", # The external description of the channel.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
},
},
],
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
}</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 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|