Skip to content

Commit 7d5badb

Browse files
author
Jon Wayne Parrott
committed
Update documentation
1 parent bf7066e commit 7d5badb

File tree

331 files changed

+62442
-6940
lines changed

Some content is hidden

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

331 files changed

+62442
-6940
lines changed

‎docs/dyn/acceleratedmobilepageurl_v1.ampUrls.html

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
<html><body>
2+
<style>
3+
4+
body, h1, h2, h3, div, span, p, pre, a {
5+
margin: 0;
6+
padding: 0;
7+
border: 0;
8+
font-weight: inherit;
9+
font-style: inherit;
10+
font-size: 100%;
11+
font-family: inherit;
12+
vertical-align: baseline;
13+
}
14+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, h2, h3 {
50+
border-bottom: solid #CCC 1px;
51+
}
52+
53+
.toc_element {
54+
margin-top: 0.5em;
55+
}
56+
57+
.firstline {
58+
margin-left: 2 em;
59+
}
60+
61+
.method {
62+
margin-top: 1em;
63+
border: solid 1px #CCC;
64+
padding: 1em;
65+
background: #EEE;
66+
}
67+
68+
.details {
69+
font-weight: bold;
70+
font-size: 14px;
71+
}
72+
73+
style>
74+
75+
<h1><a href="acceleratedmobilepageurl_v1.html">Accelerated Mobile Pages (AMP) URL APIa> . <a href="acceleratedmobilepageurl_v1.ampUrls.html">ampUrlsa>h1>
76+
<h2>Instance Methodsh2>
77+
<p class="toc_element">
78+
<code><a href="#batchGet">batchGet(body, x__xgafv=None)a>code>p>
79+
<p class="firstline">Returns AMP URL(s) and equivalentp>
80+
<h3>Method Detailsh3>
81+
<div class="method">
82+
<code class="details" id="batchGet">batchGet(body, x__xgafv=None)code>
83+
<pre>Returns AMP URL(s) and equivalent
84+
[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).
85+
86+
Args:
87+
body: object, The request body. (required)
88+
The object takes the form of:
89+
90+
{ # AMP URL request for a batch of URLs.
91+
"lookupStrategy": "A String", # The lookup_strategy being requested.
92+
"urls": [ # List of URLs to look up for the paired AMP URLs.
93+
# The URLs are case-sensitive. Up to 50 URLs per lookup
94+
# (see [Usage Limits](/amp/cache/reference/limits)).
95+
"A String",
96+
],
97+
}
98+
99+
x__xgafv: string, V1 error format.
100+
Allowed values
101+
1 - v1 error format
102+
2 - v2 error format
103+
104+
Returns:
105+
An object of the form:
106+
107+
{ # Batch AMP URL response.
108+
"ampUrls": [ # For each URL in BatchAmpUrlsRequest, the URL response. The response might
109+
# not be in the same order as URLs in the batch request.
110+
# If BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated
111+
# only once.
112+
{ # AMP URL response for a requested URL.
113+
"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.
115+
"originalUrl": "A String", # The original non-AMP URL.
116+
},
117+
],
118+
"urlErrors": [ # The errors for requested URLs that have no AMP URL.
119+
{ # AMP URL Error resource for a requested URL that couldn't be found.
120+
"errorCode": "A String", # The error code of an API call.
121+
"errorMessage": "A String", # An optional descriptive error message.
122+
"originalUrl": "A String", # The original non-AMP URL.
123+
},
124+
],
125+
}pre>
126+
div>
127+
128+
body>html>

‎docs/dyn/acceleratedmobilepageurl_v1.html

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
<html><body>
2+
<style>
3+
4+
body, h1, h2, h3, div, span, p, pre, a {
5+
margin: 0;
6+
padding: 0;
7+
border: 0;
8+
font-weight: inherit;
9+
font-style: inherit;
10+
font-size: 100%;
11+
font-family: inherit;
12+
vertical-align: baseline;
13+
}
14+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, h2, h3 {
50+
border-bottom: solid #CCC 1px;
51+
}
52+
53+
.toc_element {
54+
margin-top: 0.5em;
55+
}
56+
57+
.firstline {
58+
margin-left: 2 em;
59+
}
60+
61+
.method {
62+
margin-top: 1em;
63+
border: solid 1px #CCC;
64+
padding: 1em;
65+
background: #EEE;
66+
}
67+
68+
.details {
69+
font-weight: bold;
70+
font-size: 14px;
71+
}
72+
73+
style>
74+
75+
<h1><a href="acceleratedmobilepageurl_v1.html">Accelerated Mobile Pages (AMP) URL APIa>h1>
76+
<h2>Instance Methodsh2>
77+
<p class="toc_element">
78+
<code><a href="acceleratedmobilepageurl_v1.ampUrls.html">ampUrls()a>code>
79+
p>
80+
<p class="firstline">Returns the ampUrls Resource.p>
81+
82+
<p class="toc_element">
83+
<code><a href="#new_batch_http_request">new_batch_http_request()a>code>p>
84+
<p class="firstline">Create a BatchHttpRequest object based on the discovery document.p>
85+
<h3>Method Detailsh3>
86+
<div class="method">
87+
<code class="details" id="new_batch_http_request">new_batch_http_request()code>
88+
<pre>Create a BatchHttpRequest object based on the discovery document.
89+
90+
Args:
91+
callback: callable, A callback to be called for each response, of the
92+
form callback(id, response, exception). The first parameter is the
93+
request id, and the second is the deserialized response object. The
94+
third is an apiclient.errors.HttpError exception object if an HTTP
95+
error occurred while processing the request, or None if no error
96+
occurred.
97+
98+
Returns:
99+
A BatchHttpRequest object based on the discovery document.
100+
pre>
101+
div>
102+
103+
body>html>

‎docs/dyn/adexchangebuyer_v1_4.creatives.html

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,9 @@

Method Details

133133
"clickThroughUrl": [ # The set of destination urls for the snippet.
134134
"A String",
135135
],
136+
"languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
137+
"A String",
138+
],
136139
"width": 42, # Ad width.
137140
"nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
138141
"body": "A String", # A long description of the ad.
@@ -174,6 +177,9 @@

Method Details

174177
42,
175178
],
176179
"agencyId": "A String", # The agency id for this creative.
180+
"detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests.
181+
"A String",
182+
],
177183
"dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
178184
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
179185
"A String",
@@ -211,6 +217,20 @@

Method Details

211217
],
212218
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
213219
{
220+
"contexts": [ # All known serving contexts containing serving status information.
221+
{
222+
"platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
223+
"A String",
224+
],
225+
"contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
226+
"auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
227+
"A String",
228+
],
229+
"geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
230+
42,
231+
],
232+
},
233+
],
214234
"reason": "A String", # The type of correction that was applied to the creative.
215235
"details": [ # Additional details about the correction.
216236
"A String",
@@ -255,6 +275,9 @@

Method Details

255275
"clickThroughUrl": [ # The set of destination urls for the snippet.
256276
"A String",
257277
],
278+
"languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
279+
"A String",
280+
],
258281
"width": 42, # Ad width.
259282
"nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
260283
"body": "A String", # A long description of the ad.
@@ -296,6 +319,9 @@

Method Details

296319
42,
297320
],
298321
"agencyId": "A String", # The agency id for this creative.
322+
"detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests.
323+
"A String",
324+
],
299325
"dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
300326
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
301327
"A String",
@@ -333,6 +359,20 @@

Method Details

333359
],
334360
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
335361
{
362+
"contexts": [ # All known serving contexts containing serving status information.
363+
{
364+
"platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
365+
"A String",
366+
],
367+
"contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
368+
"auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
369+
"A String",
370+
],
371+
"geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
372+
42,
373+
],
374+
},
375+
],
336376
"reason": "A String", # The type of correction that was applied to the creative.
337377
"details": [ # Additional details about the correction.
338378
"A String",
@@ -372,6 +412,9 @@

Method Details

372412
"clickThroughUrl": [ # The set of destination urls for the snippet.
373413
"A String",
374414
],
415+
"languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
416+
"A String",
417+
],
375418
"width": 42, # Ad width.
376419
"nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
377420
"body": "A String", # A long description of the ad.
@@ -413,6 +456,9 @@

Method Details

413456
42,
414457
],
415458
"agencyId": "A String", # The agency id for this creative.
459+
"detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests.
460+
"A String",
461+
],
416462
"dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
417463
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
418464
"A String",
@@ -450,6 +496,20 @@

Method Details

450496
],
451497
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
452498
{
499+
"contexts": [ # All known serving contexts containing serving status information.
500+
{
501+
"platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
502+
"A String",
503+
],
504+
"contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
505+
"auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
506+
"A String",
507+
],
508+
"geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
509+
42,
510+
],
511+
},
512+
],
453513
"reason": "A String", # The type of correction that was applied to the creative.
454514
"details": [ # Additional details about the correction.
455515
"A String",
@@ -514,6 +574,9 @@

Method Details

514574
"clickThroughUrl": [ # The set of destination urls for the snippet.
515575
"A String",
516576
],
577+
"languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
578+
"A String",
579+
],
517580
"width": 42, # Ad width.
518581
"nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
519582
"body": "A String", # A long description of the ad.
@@ -555,6 +618,9 @@

Method Details

555618
42,
556619
],
557620
"agencyId": "A String", # The agency id for this creative.
621+
"detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests.
622+
"A String",
623+
],
558624
"dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
559625
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
560626
"A String",
@@ -592,6 +658,20 @@

Method Details

592658
],
593659
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
594660
{
661+
"contexts": [ # All known serving contexts containing serving status information.
662+
{
663+
"platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
664+
"A String",
665+
],
666+
"contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
667+
"auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
668+
"A String",
669+
],
670+
"geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
671+
42,
672+
],
673+
},
674+
],
595675
"reason": "A String", # The type of correction that was applied to the creative.
596676
"details": [ # Additional details about the correction.
597677
"A String",

0 commit comments

Comments
 (0)