docs/dyn/adsenseplatform_v1.platforms.accounts.sites.html - platform/external/python/google-api-python-client - Git at Google

 <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_v1.html">AdSense Platform API</a> . <a href="adsenseplatform_v1.platforms.html">platforms</a> . <a href="adsenseplatform_v1.platforms.accounts.html">accounts</a> . <a href="adsenseplatform_v1.platforms.accounts.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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Creates a site for a specified account.</p>
 <p class="toc_element">
   <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Deletes a site from a specified account.</p>
 <p class="toc_element">
   <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Gets a site from a specified sub-account.</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 sites for a specific 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="#requestReview">requestReview(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.</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(parent, body=None, x__xgafv=None)</code>
   <pre>Creates a site for a specified account.

 Args:
   parent: string, Required. Account to create site. Format: platforms/{platform}/accounts/{account_id} (required)
   body: object, The request body.
     The object takes the form of:

 { # Representation of a Site.
   &quot;domain&quot;: &quot;A String&quot;, # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
   &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
   &quot;state&quot;: &quot;A String&quot;, # Output only. State of a site.
 }

   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 Site.
   &quot;domain&quot;: &quot;A String&quot;, # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
   &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
   &quot;state&quot;: &quot;A String&quot;, # Output only. State of a site.
 }</pre>
 </div>

 <div class="method">
     <code class="details" id="delete">delete(name, x__xgafv=None)</code>
   <pre>Deletes a site from a specified account.

 Args:
   name: string, Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
   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="get">get(name, x__xgafv=None)</code>
   <pre>Gets a site from a specified sub-account.

 Args:
   name: string, Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{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 Site.
   &quot;domain&quot;: &quot;A String&quot;, # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
   &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
   &quot;state&quot;: &quot;A String&quot;, # Output only. State of a site.
 }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
   <pre>Lists sites for a specific account.

 Args:
   parent: string, Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account} (required)
   pageSize: integer, The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
   pageToken: string, A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` 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 site list rpc.
   &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through sites. To retrieve the next page of the results, set the next request&#x27;s &quot;page_token&quot; value to this.
   &quot;sites&quot;: [ # The sites returned in this list response.
     { # Representation of a Site.
       &quot;domain&quot;: &quot;A String&quot;, # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
       &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
       &quot;state&quot;: &quot;A String&quot;, # Output only. State of a 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="requestReview">requestReview(name, x__xgafv=None)</code>
   <pre>Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.

 Args:
   name: string, Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
   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 site request review rpc.
 }</pre>
 </div>

 </body></html>
	<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_v1.html">AdSense Platform API</a> . <a href="adsenseplatform_v1.platforms.html">platforms</a> . <a href="adsenseplatform_v1.platforms.accounts.html">accounts</a> . <a href="adsenseplatform_v1.platforms.accounts.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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Creates a site for a specified account.</p>
	<p class="toc_element">
	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Deletes a site from a specified account.</p>
	<p class="toc_element">
	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Gets a site from a specified sub-account.</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 sites for a specific 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="#requestReview">requestReview(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.</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(parent, body=None, x__xgafv=None)</code>
	<pre>Creates a site for a specified account.

	Args:
	parent: string, Required. Account to create site. Format: platforms/{platform}/accounts/{account_id} (required)
	body: object, The request body.
	The object takes the form of:

	{ # Representation of a Site.
	"domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
	"name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
	"state": "A String", # Output only. State of a site.
	}

	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 Site.
	"domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
	"name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
	"state": "A String", # Output only. State of a site.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
	<pre>Deletes a site from a specified account.

	Args:
	name: string, Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
	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="get">get(name, x__xgafv=None)</code>
	<pre>Gets a site from a specified sub-account.

	Args:
	name: string, Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{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 Site.
	"domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
	"name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
	"state": "A String", # Output only. State of a site.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
	<pre>Lists sites for a specific account.

	Args:
	parent: string, Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account} (required)
	pageSize: integer, The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
	pageToken: string, A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` 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 site list rpc.
	"nextPageToken": "A String", # Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this.
	"sites": [ # The sites returned in this list response.
	{ # Representation of a Site.
	"domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
	"name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
	"state": "A String", # Output only. State of a 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 'execute()' 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="requestReview">requestReview(name, x__xgafv=None)</code>
	<pre>Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.

	Args:
	name: string, Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
	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 site request review rpc.
	}</pre>
	</div>

	</body></html>