Skip to content

Commit 7aeeb4c

Browse files
yoshi-automationyoshi-automation
committed
chore(docs): Add new discovery artifacts and reference documents
1 parent d191d23 commit 7aeeb4c

22 files changed

+6871
-718
lines changed

‎docs/dyn/adsense_v2.accounts.adclients.adunits.html

Lines changed: 238 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,238 @@
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="adsense_v2.html">AdSense Management API</a> . <a href="adsense_v2.accounts.html">accounts</a> . <a href="adsense_v2.accounts.adclients.html">adclients</a> . <a href="adsense_v2.accounts.adclients.adunits.html">adunits</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#close">close()</a></code></p>
79+
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Gets an ad unit from a specified account and ad client.</p>
83+
<p class="toc_element">
84+
<code><a href="#getAdcode">getAdcode(name, x__xgafv=None)</a></code></p>
85+
<p class="firstline">Gets the AdSense code for a given ad unit.</p>
86+
<p class="toc_element">
87+
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88+
<p class="firstline">Lists all ad units under a specified account and ad client.</p>
89+
<p class="toc_element">
90+
<code><a href="#listLinkedCustomChannels">listLinkedCustomChannels(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91+
<p class="firstline">Lists all the custom channels available for an ad unit.</p>
92+
<p class="toc_element">
93+
<code><a href="#listLinkedCustomChannels_next">listLinkedCustomChannels_next(previous_request, previous_response)</a></code></p>
94+
<p class="firstline">Retrieves the next page of results.</p>
95+
<p class="toc_element">
96+
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97+
<p class="firstline">Retrieves the next page of results.</p>
98+
<h3>Method Details</h3>
99+
<div class="method">
100+
<code class="details" id="close">close()</code>
101+
<pre>Close httplib2 connections.</pre>
102+
</div>
103+
104+
<div class="method">
105+
<code class="details" id="get">get(name, x__xgafv=None)</code>
106+
<pre>Gets an ad unit from a specified account and ad client.
107+
108+
Args:
109+
name: string, Required. AdUnit to get information about. Format: accounts/{account_id}/adclient/{adclient_id}/adunit/{adunit_id} (required)
110+
x__xgafv: string, V1 error format.
111+
Allowed values
112+
1 - v1 error format
113+
2 - v2 error format
114+
115+
Returns:
116+
An object of the form:
117+
118+
{ # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
119+
&quot;contentAdsSettings&quot;: { # Settings specific to content ads (AFC). # Settings specific to content ads (AFC).
120+
&quot;size&quot;: &quot;A String&quot;, # Size of the ad unit. e.g. &quot;728x90&quot;, &quot;1x3&quot; (for responsive ad units).
121+
&quot;type&quot;: &quot;A String&quot;, # Type of the ad unit.
122+
},
123+
&quot;displayName&quot;: &quot;A String&quot;, # Display name of the ad unit, as provided when the ad unit was created.
124+
&quot;name&quot;: &quot;A String&quot;, # Resource name of the ad unit. Format: accounts/{account}/adclient/{adclient}/adunits/{adunit}
125+
&quot;reportingDimensionId&quot;: &quot;A String&quot;, # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
126+
&quot;state&quot;: &quot;A String&quot;, # State of the ad unit.
127+
}</pre>
128+
</div>
129+
130+
<div class="method">
131+
<code class="details" id="getAdcode">getAdcode(name, x__xgafv=None)</code>
132+
<pre>Gets the AdSense code for a given ad unit.
133+
134+
Args:
135+
name: string, Required. Name of the adunit for which to get the adcode. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} (required)
136+
x__xgafv: string, V1 error format.
137+
Allowed values
138+
1 - v1 error format
139+
2 - v2 error format
140+
141+
Returns:
142+
An object of the form:
143+
144+
{ # Representation of the AdSense code for a given ad unit.
145+
&quot;adCode&quot;: &quot;A String&quot;, # Output only. The AdSense code snippet to add to the body of an HTML page.
146+
}</pre>
147+
</div>
148+
149+
<div class="method">
150+
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
151+
<pre>Lists all ad units under a specified account and ad client.
152+
153+
Args:
154+
parent: string, Required. The ad client which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient} (required)
155+
pageSize: integer, The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
156+
pageToken: string, A page token, received from a previous `ListAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdUnits` must match the call that provided the page token.
157+
x__xgafv: string, V1 error format.
158+
Allowed values
159+
1 - v1 error format
160+
2 - v2 error format
161+
162+
Returns:
163+
An object of the form:
164+
165+
{ # Response definition for the adunit list rpc.
166+
&quot;adUnits&quot;: [ # The ad units returned in the list response.
167+
{ # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
168+
&quot;contentAdsSettings&quot;: { # Settings specific to content ads (AFC). # Settings specific to content ads (AFC).
169+
&quot;size&quot;: &quot;A String&quot;, # Size of the ad unit. e.g. &quot;728x90&quot;, &quot;1x3&quot; (for responsive ad units).
170+
&quot;type&quot;: &quot;A String&quot;, # Type of the ad unit.
171+
},
172+
&quot;displayName&quot;: &quot;A String&quot;, # Display name of the ad unit, as provided when the ad unit was created.
173+
&quot;name&quot;: &quot;A String&quot;, # Resource name of the ad unit. Format: accounts/{account}/adclient/{adclient}/adunits/{adunit}
174+
&quot;reportingDimensionId&quot;: &quot;A String&quot;, # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
175+
&quot;state&quot;: &quot;A String&quot;, # State of the ad unit.
176+
},
177+
],
178+
&quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through ad units. To retrieve the next page of the results, set the next request&#x27;s &quot;page_token&quot; value to this.
179+
}</pre>
180+
</div>
181+
182+
<div class="method">
183+
<code class="details" id="listLinkedCustomChannels">listLinkedCustomChannels(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
184+
<pre>Lists all the custom channels available for an ad unit.
185+
186+
Args:
187+
parent: string, Required. The ad unit which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} (required)
188+
pageSize: integer, The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
189+
pageToken: string, A page token, received from a previous `ListLinkedCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedCustomChannels` must match the call that provided the page token.
190+
x__xgafv: string, V1 error format.
191+
Allowed values
192+
1 - v1 error format
193+
2 - v2 error format
194+
195+
Returns:
196+
An object of the form:
197+
198+
{ # Response definition for the custom channels linked to an adunit list rpc.
199+
&quot;customChannels&quot;: [ # The custom channels returned in this list response.
200+
{ # Representation of a custom channel.
201+
&quot;displayName&quot;: &quot;A String&quot;, # Display name of the custom channel.
202+
&quot;name&quot;: &quot;A String&quot;, # Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
203+
&quot;reportingDimensionId&quot;: &quot;A String&quot;, # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
204+
},
205+
],
206+
&quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through alerts. To retrieve the next page of the results, set the next request&#x27;s &quot;page_token&quot; value to this.
207+
}</pre>
208+
</div>
209+
210+
<div class="method">
211+
<code class="details" id="listLinkedCustomChannels_next">listLinkedCustomChannels_next(previous_request, previous_response)</code>
212+
<pre>Retrieves the next page of results.
213+
214+
Args:
215+
previous_request: The request for the previous page. (required)
216+
previous_response: The response from the request for the previous page. (required)
217+
218+
Returns:
219+
A request object that you can call &#x27;execute()&#x27; on to request the next
220+
page. Returns None if there are no more items in the collection.
221+
</pre>
222+
</div>
223+
224+
<div class="method">
225+
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
226+
<pre>Retrieves the next page of results.
227+
228+
Args:
229+
previous_request: The request for the previous page. (required)
230+
previous_response: The response from the request for the previous page. (required)
231+
232+
Returns:
233+
A request object that you can call &#x27;execute()&#x27; on to request the next
234+
page. Returns None if there are no more items in the collection.
235+
</pre>
236+
</div>
237+
238+
</body></html>

0 commit comments

Comments
 (0)