blob: b3965e943e87ee56ff49da7e8fd38133f393299d [file]
<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="adsenseplatform_v1alpha.html">AdSense Platform API</a> . <a href="adsenseplatform_v1alpha.accounts.html">accounts</a> . <a href="adsenseplatform_v1alpha.accounts.platforms.html">platforms</a> . <a href="adsenseplatform_v1alpha.accounts.platforms.childAccounts.html">childAccounts</a> . <a href="adsenseplatform_v1alpha.accounts.platforms.childAccounts.sites.html">sites</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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a Platform Child Site for a specified Platform Child Account and site.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Platform Child Sites for a specified Platform Child Account.</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="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update a Platform Child Site.</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="get">get(name, x__xgafv=None)</code>
<pre>Gets a Platform Child Site for a specified Platform Child Account and site.
Args:
name: string, Required. The name of the platform child site to retrieve. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platform_child_site} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of a Transparent Platform Child Site.
&quot;domain&quot;: &quot;A String&quot;, # Output only. Domain URL of the Platform Child Site. Part of the PlatformChildSite name.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platform_child_site}
&quot;platformGroup&quot;: &quot;A String&quot;, # Resource name of the Platform Group of the Platform Child Site.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Platform Child Sites for a specified Platform Child Account.
Args:
parent: string, Required. The name of the child account under the given platform which owns the platform child sites. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account} (required)
pageSize: integer, Optional. The maximum number of children to include in the response, used for paging. If unspecified, at most 10000 platforms will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
pageToken: string, Optional. A page token, received from a previous `ListPlatformChildSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPlatformChildSites` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response definition for the list platform child sites rpc.
&quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through platforms. To retrieve the next page of the results, set the next request&#x27;s &quot;page_token&quot; value to this.
&quot;platformChildSites&quot;: [ # The platform child sites returned in this list response.
{ # Representation of a Transparent Platform Child Site.
&quot;domain&quot;: &quot;A String&quot;, # Output only. Domain URL of the Platform Child Site. Part of the PlatformChildSite name.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platform_child_site}
&quot;platformGroup&quot;: &quot;A String&quot;, # Resource name of the Platform Group of the Platform Child Site.
},
],
}</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 &#x27;execute()&#x27; 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="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Update a Platform Child Site.
Args:
name: string, Identifier. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platform_child_site} (required)
body: object, The request body.
The object takes the form of:
{ # Representation of a Transparent Platform Child Site.
&quot;domain&quot;: &quot;A String&quot;, # Output only. Domain URL of the Platform Child Site. Part of the PlatformChildSite name.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platform_child_site}
&quot;platformGroup&quot;: &quot;A String&quot;, # Resource name of the Platform Group of the Platform Child Site.
}
updateMask: string, Optional. The list of fields to update - currently only supports updating the `platform_group` field.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of a Transparent Platform Child Site.
&quot;domain&quot;: &quot;A String&quot;, # Output only. Domain URL of the Platform Child Site. Part of the PlatformChildSite name.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platform_child_site}
&quot;platformGroup&quot;: &quot;A String&quot;, # Resource name of the Platform Group of the Platform Child Site.
}</pre>
</div>
</body></html>