Skip to content

Commit ea3a5e1

Browse files
saicheemsJon Wayne Parrott
authored andcommitted
Update docs (#291)
1 parent a61611c commit ea3a5e1

File tree

268 files changed

+10827
-3094
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

268 files changed

+10827
-3094
lines changed

docs/dyn/acceleratedmobilepageurl_v1.ampUrls.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@ <h3>Method Details</h3>
111111
# only once.
112112
{ # AMP URL response for a requested URL.
113113
"ampUrl": "A String", # The AMP URL pointing to the publisher's web server.
114-
"cdnAmpUrl": "A String", # The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to the cached document in the Google AMP Cache.
114+
"cdnAmpUrl": "A String", # The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to
115+
# the cached document in the Google AMP Cache.
115116
"originalUrl": "A String", # The original non-AMP URL.
116117
},
117118
],

docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h3>Method Details</h3>
126126
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
127127
"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
128128
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
129-
# `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
129+
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
130130
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
131131
"entityId": "A String", # Numerical identifier of the client entity.
132132
# The entity can be an advertiser, a brand, or an agency.
@@ -174,7 +174,7 @@ <h3>Method Details</h3>
174174
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
175175
"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
176176
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
177-
# `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
177+
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
178178
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
179179
"entityId": "A String", # Numerical identifier of the client entity.
180180
# The entity can be an advertiser, a brand, or an agency.
@@ -230,7 +230,7 @@ <h3>Method Details</h3>
230230
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
231231
"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
232232
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
233-
# `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
233+
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
234234
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
235235
"entityId": "A String", # Numerical identifier of the client entity.
236236
# The entity can be an advertiser, a brand, or an agency.
@@ -300,7 +300,7 @@ <h3>Method Details</h3>
300300
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
301301
"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
302302
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
303-
# `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
303+
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
304304
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
305305
"entityId": "A String", # Numerical identifier of the client entity.
306306
# The entity can be an advertiser, a brand, or an agency.
@@ -368,7 +368,7 @@ <h3>Method Details</h3>
368368
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
369369
"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
370370
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
371-
# `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
371+
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
372372
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
373373
"entityId": "A String", # Numerical identifier of the client entity.
374374
# The entity can be an advertiser, a brand, or an agency.
@@ -416,7 +416,7 @@ <h3>Method Details</h3>
416416
"entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
417417
"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
418418
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
419-
# `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
419+
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
420420
"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
421421
"entityId": "A String", # Numerical identifier of the client entity.
422422
# The entity can be an advertiser, a brand, or an agency.

docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.invitations.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ <h3>Method Details</h3>
9999
body: object, The request body. (required)
100100
The object takes the form of:
101101

102-
{ # An invitation for a new client user to get access to the AdExchange Buyer UI.
103-
#
102+
{ # An invitation for a new client user to get access to the Ad Exchange
103+
# Buyer UI.
104104
# All fields are required unless otherwise specified.
105105
"clientAccountId": "A String", # Numerical account ID of the client buyer
106106
# that the invited user is associated with.
@@ -120,8 +120,8 @@ <h3>Method Details</h3>
120120
Returns:
121121
An object of the form:
122122

123-
{ # An invitation for a new client user to get access to the AdExchange Buyer UI.
124-
#
123+
{ # An invitation for a new client user to get access to the Ad Exchange
124+
# Buyer UI.
125125
# All fields are required unless otherwise specified.
126126
"clientAccountId": "A String", # Numerical account ID of the client buyer
127127
# that the invited user is associated with.
@@ -151,8 +151,8 @@ <h3>Method Details</h3>
151151
Returns:
152152
An object of the form:
153153

154-
{ # An invitation for a new client user to get access to the AdExchange Buyer UI.
155-
#
154+
{ # An invitation for a new client user to get access to the Ad Exchange
155+
# Buyer UI.
156156
# All fields are required unless otherwise specified.
157157
"clientAccountId": "A String", # Numerical account ID of the client buyer
158158
# that the invited user is associated with.
@@ -203,8 +203,8 @@ <h3>Method Details</h3>
203203
# method to retrieve the next
204204
# page of results.
205205
"invitations": [ # The returned list of client users.
206-
{ # An invitation for a new client user to get access to the AdExchange Buyer UI.
207-
#
206+
{ # An invitation for a new client user to get access to the Ad Exchange
207+
# Buyer UI.
208208
# All fields are required unless otherwise specified.
209209
"clientAccountId": "A String", # Numerical account ID of the client buyer
210210
# that the invited user is associated with.

docs/dyn/adexchangebuyer_v1_4.accounts.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,10 @@ <h2>Instance Methods</h2>
8181
<code><a href="#list">list()</a></code></p>
8282
<p class="firstline">Retrieves the authenticated user's list of accounts.</p>
8383
<p class="toc_element">
84-
<code><a href="#patch">patch(id, body)</a></code></p>
84+
<code><a href="#patch">patch(id, body, confirmUnsafeAccountChange=None)</a></code></p>
8585
<p class="firstline">Updates an existing account. This method supports patch semantics.</p>
8686
<p class="toc_element">
87-
<code><a href="#update">update(id, body)</a></code></p>
87+
<code><a href="#update">update(id, body, confirmUnsafeAccountChange=None)</a></code></p>
8888
<p class="firstline">Updates an existing account.</p>
8989
<h3>Method Details</h3>
9090
<div class="method">
@@ -166,7 +166,7 @@ <h3>Method Details</h3>
166166
</div>
167167

168168
<div class="method">
169-
<code class="details" id="patch">patch(id, body)</code>
169+
<code class="details" id="patch">patch(id, body, confirmUnsafeAccountChange=None)</code>
170170
<pre>Updates an existing account. This method supports patch semantics.
171171

172172
Args:
@@ -200,6 +200,7 @@ <h3>Method Details</h3>
200200
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
201201
}
202202

203+
confirmUnsafeAccountChange: boolean, Confirmation for erasing bidder and cookie matching urls.
203204

204205
Returns:
205206
An object of the form:
@@ -232,7 +233,7 @@ <h3>Method Details</h3>
232233
</div>
233234

234235
<div class="method">
235-
<code class="details" id="update">update(id, body)</code>
236+
<code class="details" id="update">update(id, body, confirmUnsafeAccountChange=None)</code>
236237
<pre>Updates an existing account.
237238

238239
Args:
@@ -266,6 +267,7 @@ <h3>Method Details</h3>
266267
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
267268
}
268269

270+
confirmUnsafeAccountChange: boolean, Confirmation for erasing bidder and cookie matching urls.
269271

270272
Returns:
271273
An object of the form:

docs/dyn/adexchangebuyer_v1_4.creatives.html

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,9 @@ <h2>Instance Methods</h2>
8686
<p class="toc_element">
8787
<code><a href="#list">list(dealsStatusFilter=None, openAuctionStatusFilter=None, pageToken=None, maxResults=None, buyerCreativeId=None, accountId=None)</a></code></p>
8888
<p class="firstline">Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.</p>
89+
<p class="toc_element">
90+
<code><a href="#listDeals">listDeals(accountId, buyerCreativeId)</a></code></p>
91+
<p class="firstline">Lists the external deal ids associated with the creative.</p>
8992
<p class="toc_element">
9093
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
9194
<p class="firstline">Retrieves the next page of results.</p>
@@ -129,18 +132,19 @@ <h3>Method Details</h3>
129132
"A String",
130133
],
131134
"accountId": 42, # Account id.
132-
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
135+
"videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above.
133136
"clickThroughUrl": [ # The set of destination urls for the snippet.
134137
"A String",
135138
],
136139
"languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
137140
"A String",
138141
],
139142
"width": 42, # Ad width.
140-
"nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
143+
"nativeAd": { # If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
141144
"body": "A String", # A long description of the ad.
142145
"advertiser": "A String",
143146
"store": "A String", # The URL to the app store to purchase/download the promoted app.
147+
"videoURL": "A String",
144148
"headline": "A String", # A short title for the ad.
145149
"image": { # A large image.
146150
"url": "A String",
@@ -271,18 +275,19 @@ <h3>Method Details</h3>
271275
"A String",
272276
],
273277
"accountId": 42, # Account id.
274-
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
278+
"videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above.
275279
"clickThroughUrl": [ # The set of destination urls for the snippet.
276280
"A String",
277281
],
278282
"languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
279283
"A String",
280284
],
281285
"width": 42, # Ad width.
282-
"nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
286+
"nativeAd": { # If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
283287
"body": "A String", # A long description of the ad.
284288
"advertiser": "A String",
285289
"store": "A String", # The URL to the app store to purchase/download the promoted app.
290+
"videoURL": "A String",
286291
"headline": "A String", # A short title for the ad.
287292
"image": { # A large image.
288293
"url": "A String",
@@ -408,18 +413,19 @@ <h3>Method Details</h3>
408413
"A String",
409414
],
410415
"accountId": 42, # Account id.
411-
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
416+
"videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above.
412417
"clickThroughUrl": [ # The set of destination urls for the snippet.
413418
"A String",
414419
],
415420
"languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
416421
"A String",
417422
],
418423
"width": 42, # Ad width.
419-
"nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
424+
"nativeAd": { # If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
420425
"body": "A String", # A long description of the ad.
421426
"advertiser": "A String",
422427
"store": "A String", # The URL to the app store to purchase/download the promoted app.
428+
"videoURL": "A String",
423429
"headline": "A String", # A short title for the ad.
424430
"image": { # A large image.
425431
"url": "A String",
@@ -570,18 +576,19 @@ <h3>Method Details</h3>
570576
"A String",
571577
],
572578
"accountId": 42, # Account id.
573-
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
579+
"videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above.
574580
"clickThroughUrl": [ # The set of destination urls for the snippet.
575581
"A String",
576582
],
577583
"languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
578584
"A String",
579585
],
580586
"width": 42, # Ad width.
581-
"nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
587+
"nativeAd": { # If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
582588
"body": "A String", # A long description of the ad.
583589
"advertiser": "A String",
584590
"store": "A String", # The URL to the app store to purchase/download the promoted app.
591+
"videoURL": "A String",
585592
"headline": "A String", # A short title for the ad.
586593
"image": { # A large image.
587594
"url": "A String",
@@ -693,6 +700,29 @@ <h3>Method Details</h3>
693700
}</pre>
694701
</div>
695702

703+
<div class="method">
704+
<code class="details" id="listDeals">listDeals(accountId, buyerCreativeId)</code>
705+
<pre>Lists the external deal ids associated with the creative.
706+
707+
Args:
708+
accountId: integer, The id for the account that will serve this creative. (required)
709+
buyerCreativeId: string, The buyer-specific id for this creative. (required)
710+
711+
Returns:
712+
An object of the form:
713+
714+
{ # The external deal ids associated with a creative.
715+
"dealStatuses": [ # A list of external deal ids and ARC approval status.
716+
{
717+
"webPropertyId": 42, # Publisher ID.
718+
"dealId": "A String", # External deal ID.
719+
"arcStatus": "A String", # ARC approval status.
720+
},
721+
],
722+
"kind": "adexchangebuyer#creativeDealIds", # Resource type.
723+
}</pre>
724+
</div>
725+
696726
<div class="method">
697727
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
698728
<pre>Retrieves the next page of results.

0 commit comments

Comments
 (0)