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
|
<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.adGroups.html">adGroups</a> . <a href="displayvideo_v4.advertisers.adGroups.youtubeAssetTypes.html">youtubeAssetTypes</a> . <a href="displayvideo_v4.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.html">youtubeAssetAssociations</a></h1>
<h2>Instance Methods</h2>
<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, adGroupId, youtubeAssetType, body=None, linkedEntity_lineItemId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.</p>
<p class="toc_element">
<code><a href="#delete">delete(advertiserId, adGroupId, youtubeAssetType, youtubeAssetAssociationId, linkedEntity_lineItemId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.</p>
<p class="toc_element">
<code><a href="#list">list(advertiserId, adGroupId, youtubeAssetType, linkedEntity_lineItemId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the YouTube asset associations linked to the given resource.</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="create">create(advertiserId, adGroupId, youtubeAssetType, body=None, linkedEntity_lineItemId=None, x__xgafv=None)</code>
<pre>Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.
Args:
advertiserId: string, Required. The ID of the advertiser that the linked entity belongs to. (required)
adGroupId: string, The ID of an ad group. (required)
youtubeAssetType: string, Required. The type of YouTube asset associated with the resource. (required)
Allowed values
YOUTUBE_ASSET_TYPE_UNSPECIFIED - YouTube asset type is not specified or is unknown in this version.
YOUTUBE_ASSET_TYPE_LOCATION - Location asset.
YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - Affiliate location asset.
YOUTUBE_ASSET_TYPE_SITELINK - Sitelink asset.
body: object, The request body.
The object takes the form of:
{ # An association between a resource and a YouTube asset.
"linkedYoutubeAsset": { # A YouTube asset linked to a resource in a YoutubeAssetAssociation. # Required. The YouTube asset associated with the resource.
"affiliateLocationAssetFilter": { # An asset filter that matches eligible affiliate location assets for serving. # An affiliate location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`.
"affiliateLocationMatchingFunction": { # The matching function for an affiliate location asset filter. # Optional. The matching function that determines how the affiliate location asset filter matches affiliate location assets. This field is required and can only be set for if affiliate_location_matching_type is `SELECTED_CHAINS`.
"chains": [ # Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`.
{ # A chain of affiliate locations.
"chainId": "A String", # Required. ID of the affiliate location chain.
},
],
},
"affiliateLocationMatchingType": "A String", # Required. The matching type of this affiliate location asset filter.
"assetSetId": "A String", # Output only. The ID of the asset set that matches the affiliate location assets eligible for serving.
},
"locationAssetFilter": { # An asset filter that matches eligible location assets for serving. # A location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_LOCATION`.
"assetSetId": "A String", # Output only. The ID of the asset set that matches the location assets eligible for serving.
"locationMatchingFunction": { # The matching function for a location asset filter. # Optional. The matching function that determines how the location asset filter matches location assets. This field is required and can only be set for if location_matching_type is `FILTER` or `SELECTED_ASSETS`.
"business": "A String", # Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`.
"labels": [ # Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`.
"A String",
],
"locationAssetIds": [ # Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`.
"A String",
],
},
"locationMatchingType": "A String", # Required. The matching type of this location asset filter.
},
"sitelinkAsset": { # A sitelink asset. # A sitelink asset. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_SITELINK`.
"assetId": "A String", # Required. ID of the sitelink asset.
},
},
"name": "A String", # Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.
"youtubeAssetType": "A String", # Required. The type of YouTube asset associated with the resource.
}
linkedEntity_lineItemId: string, The ID of a line item.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An association between a resource and a YouTube asset.
"linkedYoutubeAsset": { # A YouTube asset linked to a resource in a YoutubeAssetAssociation. # Required. The YouTube asset associated with the resource.
"affiliateLocationAssetFilter": { # An asset filter that matches eligible affiliate location assets for serving. # An affiliate location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`.
"affiliateLocationMatchingFunction": { # The matching function for an affiliate location asset filter. # Optional. The matching function that determines how the affiliate location asset filter matches affiliate location assets. This field is required and can only be set for if affiliate_location_matching_type is `SELECTED_CHAINS`.
"chains": [ # Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`.
{ # A chain of affiliate locations.
"chainId": "A String", # Required. ID of the affiliate location chain.
},
],
},
"affiliateLocationMatchingType": "A String", # Required. The matching type of this affiliate location asset filter.
"assetSetId": "A String", # Output only. The ID of the asset set that matches the affiliate location assets eligible for serving.
},
"locationAssetFilter": { # An asset filter that matches eligible location assets for serving. # A location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_LOCATION`.
"assetSetId": "A String", # Output only. The ID of the asset set that matches the location assets eligible for serving.
"locationMatchingFunction": { # The matching function for a location asset filter. # Optional. The matching function that determines how the location asset filter matches location assets. This field is required and can only be set for if location_matching_type is `FILTER` or `SELECTED_ASSETS`.
"business": "A String", # Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`.
"labels": [ # Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`.
"A String",
],
"locationAssetIds": [ # Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`.
"A String",
],
},
"locationMatchingType": "A String", # Required. The matching type of this location asset filter.
},
"sitelinkAsset": { # A sitelink asset. # A sitelink asset. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_SITELINK`.
"assetId": "A String", # Required. ID of the sitelink asset.
},
},
"name": "A String", # Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.
"youtubeAssetType": "A String", # Required. The type of YouTube asset associated with the resource.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(advertiserId, adGroupId, youtubeAssetType, youtubeAssetAssociationId, linkedEntity_lineItemId=None, x__xgafv=None)</code>
<pre>Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.
Args:
advertiserId: string, Required. The ID of the advertiser that the linked entity belongs to. (required)
adGroupId: string, The ID of an ad group. (required)
youtubeAssetType: string, Required. The type of YouTube asset associated with the resource. (required)
Allowed values
YOUTUBE_ASSET_TYPE_UNSPECIFIED - YouTube asset type is not specified or is unknown in this version.
YOUTUBE_ASSET_TYPE_LOCATION - Location asset.
YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - Affiliate location asset.
YOUTUBE_ASSET_TYPE_SITELINK - Sitelink asset.
youtubeAssetAssociationId: string, Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked. (required)
linkedEntity_lineItemId: string, The ID of a line item.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(advertiserId, adGroupId, youtubeAssetType, linkedEntity_lineItemId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the YouTube asset associations linked to the given resource.
Args:
advertiserId: string, Required. The ID of the advertiser that the linked entity belongs to. (required)
adGroupId: string, The ID of an ad group. (required)
youtubeAssetType: string, Required. The type of YouTube asset being associated with the resource. (required)
Allowed values
YOUTUBE_ASSET_TYPE_UNSPECIFIED - YouTube asset type is not specified or is unknown in this version.
YOUTUBE_ASSET_TYPE_LOCATION - Location asset.
YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - Affiliate location asset.
YOUTUBE_ASSET_TYPE_SITELINK - Sitelink asset.
linkedEntity_lineItemId: string, The ID of a line item.
orderBy: string, Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.
pageSize: integer, Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. 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 `ListYoutubeAssetAssociations` 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:
{ # Response message for YoutubeAssetAssociationService.ListYoutubeAssetAssociations.
"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 `ListYoutubeAssetAssociations` method to retrieve the next page of results.
"youtubeAssetAssociations": [ # The list of asset associations. This list will be absent if empty.
{ # An association between a resource and a YouTube asset.
"linkedYoutubeAsset": { # A YouTube asset linked to a resource in a YoutubeAssetAssociation. # Required. The YouTube asset associated with the resource.
"affiliateLocationAssetFilter": { # An asset filter that matches eligible affiliate location assets for serving. # An affiliate location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`.
"affiliateLocationMatchingFunction": { # The matching function for an affiliate location asset filter. # Optional. The matching function that determines how the affiliate location asset filter matches affiliate location assets. This field is required and can only be set for if affiliate_location_matching_type is `SELECTED_CHAINS`.
"chains": [ # Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`.
{ # A chain of affiliate locations.
"chainId": "A String", # Required. ID of the affiliate location chain.
},
],
},
"affiliateLocationMatchingType": "A String", # Required. The matching type of this affiliate location asset filter.
"assetSetId": "A String", # Output only. The ID of the asset set that matches the affiliate location assets eligible for serving.
},
"locationAssetFilter": { # An asset filter that matches eligible location assets for serving. # A location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_LOCATION`.
"assetSetId": "A String", # Output only. The ID of the asset set that matches the location assets eligible for serving.
"locationMatchingFunction": { # The matching function for a location asset filter. # Optional. The matching function that determines how the location asset filter matches location assets. This field is required and can only be set for if location_matching_type is `FILTER` or `SELECTED_ASSETS`.
"business": "A String", # Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`.
"labels": [ # Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`.
"A String",
],
"locationAssetIds": [ # Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`.
"A String",
],
},
"locationMatchingType": "A String", # Required. The matching type of this location asset filter.
},
"sitelinkAsset": { # A sitelink asset. # A sitelink asset. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_SITELINK`.
"assetId": "A String", # Required. ID of the sitelink asset.
},
},
"name": "A String", # Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.
"youtubeAssetType": "A String", # Required. The type of YouTube asset associated with the resource.
},
],
}</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>
</body></html>
|
