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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
<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="displayvideo_v4.html">Display & Video 360 API</a> . <a href="displayvideo_v4.advertisers.html">advertisers</a> . <a href="displayvideo_v4.advertisers.adAssets.html">adAssets</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#bulkCreate">bulkCreate(advertiserId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.</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="#create">create(advertiserId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.</p>
<p class="toc_element">
<code><a href="#get">get(advertiserId, adAssetId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.</p>
<p class="toc_element">
<code><a href="#list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.</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>
<p class="toc_element">
<code><a href="#upload">upload(advertiserId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="bulkCreate">bulkCreate(advertiserId, body=None, x__xgafv=None)</code>
<pre>Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Args:
advertiserId: string, Required. The ID of the advertiser these ad assets belong to. (required)
body: object, The request body.
The object takes the form of:
{ # A request message for BulkCreateAdAssets.
"adAssets": [ # Required. Ad assets to create. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
{ # A single ad asset.
"adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
"adAssetType": "A String", # Required. The type of the ad asset.
"entityStatus": "A String", # Output only. The entity status of the ad asset.
"name": "A String", # Identifier. The resource name of the ad asset.
"youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
"youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A response message for BulkCreateAdAssets.
"adAssets": [ # The created ad assets.
{ # A single ad asset.
"adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
"adAssetType": "A String", # Required. The type of the ad asset.
"entityStatus": "A String", # Output only. The entity status of the ad asset.
"name": "A String", # Identifier. The resource name of the ad asset.
"youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
"youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
},
},
],
}</pre>
</div>
<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(advertiserId, body=None, x__xgafv=None)</code>
<pre>Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Args:
advertiserId: string, Required. The ID of the advertiser this ad asset belongs to. (required)
body: object, The request body.
The object takes the form of:
{ # A request message for CreateAdAsset.
"adAsset": { # A single ad asset. # Required. The ad asset to create. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
"adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
"adAssetType": "A String", # Required. The type of the ad asset.
"entityStatus": "A String", # Output only. The entity status of the ad asset.
"name": "A String", # Identifier. The resource name of the ad asset.
"youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
"youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single ad asset.
"adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
"adAssetType": "A String", # Required. The type of the ad asset.
"entityStatus": "A String", # Output only. The entity status of the ad asset.
"name": "A String", # Identifier. The resource name of the ad asset.
"youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
"youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(advertiserId, adAssetId, x__xgafv=None)</code>
<pre>Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Args:
advertiserId: string, Required. The ID of the advertiser this ad asset belongs to. (required)
adAssetId: string, Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single ad asset.
"adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
"adAssetType": "A String", # Required. The type of the ad asset.
"entityStatus": "A String", # Output only. The entity status of the ad asset.
"name": "A String", # Identifier. The resource name of the ad asset.
"youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
"youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Args:
advertiserId: string, Required. The ID of the advertiser the ad assets belong to. (required)
filter: string, Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE`
orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `adAssetId desc`.
pageSize: integer, Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdAssets` method. If not specified, the first page of results will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A response message for ListAdAssets.
"adAssets": [ # The list of ad assets. The list will only contain assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. This list will be absent if empty.
{ # A single ad asset.
"adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
"adAssetType": "A String", # Required. The type of the ad asset.
"entityStatus": "A String", # Output only. The entity status of the ad asset.
"name": "A String", # Identifier. The resource name of the ad asset.
"youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
"youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
},
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdAssets` method to retrieve the next page of results.
}</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 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="upload">upload(advertiserId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</code>
<pre>Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.
Args:
advertiserId: string, Required. The ID of the advertiser this ad asset belongs to. (required)
body: object, The request body.
The object takes the form of:
{ # A request message for UploadAdAsset.
"adAssetType": "A String", # Required. The type of the ad asset. Only `AD_ASSET_TYPE_IMAGE` is supported.
"filename": "A String", # Required. The filename of the ad asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes.
}
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A response message for UploadAdAsset.
"adAsset": { # A single ad asset. # The created ad asset.
"adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
"adAssetType": "A String", # Required. The type of the ad asset.
"entityStatus": "A String", # Output only. The entity status of the ad asset.
"name": "A String", # Identifier. The resource name of the ad asset.
"youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
"youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
},
},
}</pre>
</div>
</body></html>
|
