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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
<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.accounts.html">accounts</a> . <a href="adsense_v1_4.accounts.adunits.html">adunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_4.accounts.adunits.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels 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(accountId, adClientId, adUnitId)</a></code></p>
<p class="firstline">Gets the specified ad unit in the specified ad client for the specified account.</p>
<p class="toc_element">
<code><a href="#getAdCode">getAdCode(accountId, adClientId, adUnitId)</a></code></p>
<p class="firstline">Get ad code for the specified ad unit.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, includeInactive=None, maxResults=None, pageToken=None)</a></code></p>
<p class="firstline">List all ad units in the specified ad client for the specified 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(accountId, adClientId, adUnitId)</code>
<pre>Gets the specified ad unit in the specified ad client for the specified account.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client for which to get the ad unit. (required)
adUnitId: string, Ad unit to retrieve. (required)
Returns:
An object of the form:
{
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
"url": "A String", # URL to use when type is set to URL.
},
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"background": "A String", # The color of the ad background.
"border": "A String", # The color of the ad border.
"text": "A String", # The color of the ad text.
"title": "A String", # The color of the ad title.
"url": "A String", # The color of the ad url.
},
"corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
"feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated.
"adPosition": "A String", # The position of the ads relative to the feed entries.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"type": "A String", # The type of ads which should appear.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"name": "A String", # Name of this ad unit.
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
}</pre>
</div>
<div class="method">
<code class="details" id="getAdCode">getAdCode(accountId, adClientId, adUnitId)</code>
<pre>Get ad code for the specified ad unit.
Args:
accountId: string, Account which contains the ad client. (required)
adClientId: string, Ad client with contains the ad unit. (required)
adUnitId: string, Ad unit to get the code for. (required)
Returns:
An object of the form:
{
"adCode": "A String", # The Auto ad code snippet. The ad code snippet.
"ampBody": "A String", # The AMP Auto ad code snippet that goes in the body of an AMP page.
"ampHead": "A String", # The AMP Auto ad code snippet that goes in the head of an AMP page.
"kind": "adsense#adCode", # Kind this is, in this case adsense#adCode.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, includeInactive=None, maxResults=None, pageToken=None)</code>
<pre>List all ad units in the specified ad client for the specified account.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client for which to list ad units. (required)
includeInactive: boolean, Whether to include inactive ad units. Default: true.
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
pageToken: string, A continuation token, used to page through ad units. 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 ad units returned in this list response.
{
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
"url": "A String", # URL to use when type is set to URL.
},
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"background": "A String", # The color of the ad background.
"border": "A String", # The color of the ad border.
"text": "A String", # The color of the ad text.
"title": "A String", # The color of the ad title.
"url": "A String", # The color of the ad url.
},
"corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
"feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated.
"adPosition": "A String", # The position of the ads relative to the feed entries.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"type": "A String", # The type of ads which should appear.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"name": "A String", # Name of this ad unit.
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
},
],
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
"nextPageToken": "A String", # Continuation token used to page through ad units. 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>
|
