Refresh docs
This commit is contained in:
Joe Gregorio
@@ -25,4 +25,4 @@
|
||||
export GOOGLE_APPENGINE=$HOME/projects/google_appengine/
|
||||
export DJANGO_SETTINGS_MODULE=fakesettings
|
||||
export PYTHONPATH=`pwd`/..:$GOOGLE_APPENGINE
|
||||
epydoc --output epy --graph classtree --parse-only --docformat plaintext apiclient oauth2client
|
||||
epydoc --output epy --graph all --parse-only --docformat plaintext apiclient oauth2client
|
||||
|
||||
258
docs/dyn/adexchangebuyer_v1_2.accounts.html
Normal file
258
docs/dyn/adexchangebuyer_v1_2.accounts.html
Normal file
@@ -0,0 +1,258 @@
|
||||
<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="adexchangebuyer_v1_2.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_2.accounts.html">accounts</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(id)</a></code></p>
|
||||
<p class="firstline">Gets one account by ID.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list()</a></code></p>
|
||||
<p class="firstline">Retrieves the authenticated user's list of accounts.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#patch">patch(id, body)</a></code></p>
|
||||
<p class="firstline">Updates an existing account. This method supports patch semantics.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(id, body)</a></code></p>
|
||||
<p class="firstline">Updates an existing account.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(id)</code>
|
||||
<pre>Gets one account by ID.
|
||||
|
||||
Args:
|
||||
id: integer, The account id (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Configuration data for an Ad Exchange buyer account.
|
||||
"kind": "adexchangebuyer#account", # Resource type.
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.
|
||||
{
|
||||
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
|
||||
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
|
||||
# - ASIA
|
||||
# - EUROPE
|
||||
# - US_EAST
|
||||
# - US_WEST
|
||||
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
|
||||
},
|
||||
],
|
||||
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
|
||||
"id": 42, # Account id.
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list()</code>
|
||||
<pre>Retrieves the authenticated user's list of accounts.
|
||||
|
||||
Args:
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
|
||||
"items": [ # A list of accounts.
|
||||
{ # Configuration data for an Ad Exchange buyer account.
|
||||
"kind": "adexchangebuyer#account", # Resource type.
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.
|
||||
{
|
||||
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
|
||||
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
|
||||
# - ASIA
|
||||
# - EUROPE
|
||||
# - US_EAST
|
||||
# - US_WEST
|
||||
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
|
||||
},
|
||||
],
|
||||
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
|
||||
"id": 42, # Account id.
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
|
||||
},
|
||||
],
|
||||
"kind": "adexchangebuyer#accountsList", # Resource type.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="patch">patch(id, body)</code>
|
||||
<pre>Updates an existing account. This method supports patch semantics.
|
||||
|
||||
Args:
|
||||
id: integer, The account id (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # Configuration data for an Ad Exchange buyer account.
|
||||
"kind": "adexchangebuyer#account", # Resource type.
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.
|
||||
{
|
||||
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
|
||||
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
|
||||
# - ASIA
|
||||
# - EUROPE
|
||||
# - US_EAST
|
||||
# - US_WEST
|
||||
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
|
||||
},
|
||||
],
|
||||
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
|
||||
"id": 42, # Account id.
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Configuration data for an Ad Exchange buyer account.
|
||||
"kind": "adexchangebuyer#account", # Resource type.
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.
|
||||
{
|
||||
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
|
||||
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
|
||||
# - ASIA
|
||||
# - EUROPE
|
||||
# - US_EAST
|
||||
# - US_WEST
|
||||
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
|
||||
},
|
||||
],
|
||||
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
|
||||
"id": 42, # Account id.
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="update">update(id, body)</code>
|
||||
<pre>Updates an existing account.
|
||||
|
||||
Args:
|
||||
id: integer, The account id (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # Configuration data for an Ad Exchange buyer account.
|
||||
"kind": "adexchangebuyer#account", # Resource type.
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.
|
||||
{
|
||||
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
|
||||
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
|
||||
# - ASIA
|
||||
# - EUROPE
|
||||
# - US_EAST
|
||||
# - US_WEST
|
||||
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
|
||||
},
|
||||
],
|
||||
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
|
||||
"id": 42, # Account id.
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Configuration data for an Ad Exchange buyer account.
|
||||
"kind": "adexchangebuyer#account", # Resource type.
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.
|
||||
{
|
||||
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
|
||||
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
|
||||
# - ASIA
|
||||
# - EUROPE
|
||||
# - US_EAST
|
||||
# - US_WEST
|
||||
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
|
||||
},
|
||||
],
|
||||
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
|
||||
"id": 42, # Account id.
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
308
docs/dyn/adexchangebuyer_v1_2.creatives.html
Normal file
308
docs/dyn/adexchangebuyer_v1_2.creatives.html
Normal file
@@ -0,0 +1,308 @@
|
||||
<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="adexchangebuyer_v1_2.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_2.creatives.html">creatives</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(accountId, buyerCreativeId)</a></code></p>
|
||||
<p class="firstline">Gets the status for a single creative.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(body)</a></code></p>
|
||||
<p class="firstline">Submit a new creative.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(pageToken=None, maxResults=None, statusFilter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves a list of the authenticated user's active creatives.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(accountId, buyerCreativeId)</code>
|
||||
<pre>Gets the status for a single creative.
|
||||
|
||||
Args:
|
||||
accountId: integer, The id for the account that will serve this creative. (required)
|
||||
buyerCreativeId: string, The buyer-specific id for this creative. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A creative and its classification data.
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.
|
||||
"kind": "adexchangebuyer#creative", # Resource type.
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
|
||||
"agencyId": "A String", # The agency id for this creative.
|
||||
"width": 42, # Ad width.
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"height": 42, # Ad height.
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
|
||||
"A String",
|
||||
],
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.
|
||||
"A String",
|
||||
],
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
|
||||
{
|
||||
"reason": "A String", # The categorized reason for disapproval.
|
||||
"details": [ # Additional details about the reason for disapproval.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
],
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"accountId": 42, # Account id.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(body)</code>
|
||||
<pre>Submit a new creative.
|
||||
|
||||
Args:
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A creative and its classification data.
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.
|
||||
"kind": "adexchangebuyer#creative", # Resource type.
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
|
||||
"agencyId": "A String", # The agency id for this creative.
|
||||
"width": 42, # Ad width.
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"height": 42, # Ad height.
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
|
||||
"A String",
|
||||
],
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.
|
||||
"A String",
|
||||
],
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
|
||||
{
|
||||
"reason": "A String", # The categorized reason for disapproval.
|
||||
"details": [ # Additional details about the reason for disapproval.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
],
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"accountId": 42, # Account id.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A creative and its classification data.
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.
|
||||
"kind": "adexchangebuyer#creative", # Resource type.
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
|
||||
"agencyId": "A String", # The agency id for this creative.
|
||||
"width": 42, # Ad width.
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"height": 42, # Ad height.
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
|
||||
"A String",
|
||||
],
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.
|
||||
"A String",
|
||||
],
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
|
||||
{
|
||||
"reason": "A String", # The categorized reason for disapproval.
|
||||
"details": [ # Additional details about the reason for disapproval.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
],
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"accountId": 42, # Account id.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(pageToken=None, maxResults=None, statusFilter=None)</code>
|
||||
<pre>Retrieves a list of the authenticated user's active creatives.
|
||||
|
||||
Args:
|
||||
pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
|
||||
maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
|
||||
statusFilter: string, When specified, only creatives having the given status are returned.
|
||||
Allowed values
|
||||
approved - Creatives which have been approved.
|
||||
disapproved - Creatives which have been disapproved.
|
||||
not_checked - Creatives whose status is not yet checked.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
|
||||
"nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # A list of creatives.
|
||||
{ # A creative and its classification data.
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.
|
||||
"kind": "adexchangebuyer#creative", # Resource type.
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
|
||||
"agencyId": "A String", # The agency id for this creative.
|
||||
"width": 42, # Ad width.
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"height": 42, # Ad height.
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
|
||||
"A String",
|
||||
],
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.
|
||||
"A String",
|
||||
],
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
|
||||
{
|
||||
"reason": "A String", # The categorized reason for disapproval.
|
||||
"details": [ # Additional details about the reason for disapproval.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
],
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"accountId": 42, # Account id.
|
||||
},
|
||||
],
|
||||
"kind": "adexchangebuyer#creativesList", # Resource type.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
136
docs/dyn/adexchangebuyer_v1_2.directDeals.html
Normal file
136
docs/dyn/adexchangebuyer_v1_2.directDeals.html
Normal file
@@ -0,0 +1,136 @@
|
||||
<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="adexchangebuyer_v1_2.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_2.directDeals.html">directDeals</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(id)</a></code></p>
|
||||
<p class="firstline">Gets one direct deal by ID.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list()</a></code></p>
|
||||
<p class="firstline">Retrieves the authenticated user's list of direct deals.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(id)</code>
|
||||
<pre>Gets one direct deal by ID.
|
||||
|
||||
Args:
|
||||
id: string, The direct deal id (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # The configuration data for an Ad Exchange direct deal.
|
||||
"advertiser": "A String", # The name of the advertiser this deal is for.
|
||||
"kind": "adexchangebuyer#directDeal", # Resource type.
|
||||
"privateExchangeMinCpm": "A String", # The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).
|
||||
"currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
|
||||
"fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
|
||||
"startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
|
||||
"endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
|
||||
"sellerNetwork": "A String", # The name of the publisher offering this direct deal.
|
||||
"id": "A String", # Deal id.
|
||||
"accountId": 42, # The account id of the buyer this deal is for.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list()</code>
|
||||
<pre>Retrieves the authenticated user's list of direct deals.
|
||||
|
||||
Args:
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.
|
||||
"kind": "adexchangebuyer#directDealsList", # Resource type.
|
||||
"directDeals": [ # A list of direct deals relevant for your account.
|
||||
{ # The configuration data for an Ad Exchange direct deal.
|
||||
"advertiser": "A String", # The name of the advertiser this deal is for.
|
||||
"kind": "adexchangebuyer#directDeal", # Resource type.
|
||||
"privateExchangeMinCpm": "A String", # The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).
|
||||
"currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
|
||||
"fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
|
||||
"startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
|
||||
"endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
|
||||
"sellerNetwork": "A String", # The name of the publisher offering this direct deal.
|
||||
"id": "A String", # Deal id.
|
||||
"accountId": 42, # The account id of the buyer this deal is for.
|
||||
},
|
||||
],
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
97
docs/dyn/adexchangebuyer_v1_2.html
Normal file
97
docs/dyn/adexchangebuyer_v1_2.html
Normal file
@@ -0,0 +1,97 @@
|
||||
<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="adexchangebuyer_v1_2.html">Ad Exchange Buyer API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adexchangebuyer_v1_2.accounts.html">accounts()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the accounts Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adexchangebuyer_v1_2.creatives.html">creatives()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the creatives Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adexchangebuyer_v1_2.directDeals.html">directDeals()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the directDeals Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adexchangebuyer_v1_2.performanceReport.html">performanceReport()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the performanceReport Resource.</p>
|
||||
|
||||
</body></html>
|
||||
108
docs/dyn/adexchangebuyer_v1_2.performanceReport.html
Normal file
108
docs/dyn/adexchangebuyer_v1_2.performanceReport.html
Normal file
@@ -0,0 +1,108 @@
|
||||
<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="adexchangebuyer_v1_2.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_2.performanceReport.html">performanceReport</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(accountId, endDateTime, startDateTime)</a></code></p>
|
||||
<p class="firstline">Retrieves the authenticated user's list of performance metrics.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(accountId, endDateTime, startDateTime)</code>
|
||||
<pre>Retrieves the authenticated user's list of performance metrics.
|
||||
|
||||
Args:
|
||||
accountId: string, The account id to get the reports for. (required)
|
||||
endDateTime: string, The end time for the reports. (required)
|
||||
startDateTime: string, The start time for the reports. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # The configuration data for an Ad Exchange performance report list. TODO(nathanbullock): need to add some release tests before releasing this. https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py
|
||||
"kind": "adexchangebuyer#performanceReportList", # Resource type.
|
||||
"performance_report": [ # A list of performance reports relevant for the account.
|
||||
{
|
||||
"kind": "adexchangebuyer#performanceReport", # Resource type.
|
||||
"timestamp": "A String", # Timestamp of the starting time of this performance data.
|
||||
"region": "A String", # The trading location of this data.
|
||||
"latency50thPercentile": 3.14, # The Nth percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
|
||||
"latency85thPercentile": 3.14,
|
||||
"latency95thPercentile": 3.14,
|
||||
},
|
||||
],
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
155
docs/dyn/admin_reports_v1.activities.html
Normal file
155
docs/dyn/admin_reports_v1.activities.html
Normal file
@@ -0,0 +1,155 @@
|
||||
<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="admin_reports_v1.html">Admin Reports API</a> . <a href="admin_reports_v1.activities.html">activities</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(userKey, applicationName, eventName=None, actorIpAddress=None, filters=None, maxResults=None, pageToken=None, startTime=None, endTime=None)</a></code></p>
|
||||
<p class="firstline">Retrieves a list of activities for a specific customer and application.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(userKey, applicationName, eventName=None, actorIpAddress=None, filters=None, maxResults=None, pageToken=None, startTime=None, endTime=None)</code>
|
||||
<pre>Retrieves a list of activities for a specific customer and application.
|
||||
|
||||
Args:
|
||||
userKey: string, Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. (required)
|
||||
applicationName: string, Application name for which the events are to be retrieved. (required)
|
||||
eventName: string, Name of the event being queried.
|
||||
actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
|
||||
filters: string, Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
|
||||
maxResults: integer, Number of activity records to be shown in each page.
|
||||
pageToken: string, Token to specify next page.
|
||||
startTime: string, Return events which occured at or after this time.
|
||||
endTime: string, Return events which occured at or before this time.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # JSON template for a collection of activites.
|
||||
"nextPageToken": "A String", # Token for retrieving the next page
|
||||
"items": [ # Each record in read response.
|
||||
{ # JSON template for the activity resource.
|
||||
"kind": "admin#reports#activity", # Kind of resource this is.
|
||||
"ownerDomain": "A String", # Domain of source customer.
|
||||
"actor": { # User doing the action.
|
||||
"profileId": "A String", # Obfuscated user id of the user.
|
||||
"email": "A String", # Email address of the user.
|
||||
"key": "A String", # For OAuth 2LO API requests, consumer_key of the requestor.
|
||||
"callerType": "A String", # User or OAuth 2LO request.
|
||||
},
|
||||
"id": { # Unique identifier for each activity record.
|
||||
"applicationName": "A String", # Application name to which the event belongs.
|
||||
"uniqueQualifier": "A String", # Unique qualifier if multiple events have the same time.
|
||||
"customerId": "A String", # Obfuscated customer ID of the source customer.
|
||||
"time": "A String", # Time of occurrence of the activity.
|
||||
},
|
||||
"ipAddress": "A String", # IP Address of the user doing the action.
|
||||
"events": [ # Activity events.
|
||||
{
|
||||
"type": "A String", # Type of event.
|
||||
"name": "A String", # Name of event.
|
||||
"parameters": [ # Parameter value pairs for various applications.
|
||||
{
|
||||
"boolValue": True or False, # Boolean value of the parameter.
|
||||
"intValue": "A String", # Integral value of the parameter.
|
||||
"value": "A String", # String value of the parameter.
|
||||
"name": "A String", # The name of the parameter.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"kind": "admin#reports#activities", # Kind of list response this is.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
149
docs/dyn/admin_reports_v1.customerUsageReports.html
Normal file
149
docs/dyn/admin_reports_v1.customerUsageReports.html
Normal file
@@ -0,0 +1,149 @@
|
||||
<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="admin_reports_v1.html">Admin Reports API</a> . <a href="admin_reports_v1.customerUsageReports.html">customerUsageReports</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(date, pageToken=None, parameters=None)</a></code></p>
|
||||
<p class="firstline">Retrieves a report which is a collection of properties / statistics for a specific customer.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get_next">get_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(date, pageToken=None, parameters=None)</code>
|
||||
<pre>Retrieves a report which is a collection of properties / statistics for a specific customer.
|
||||
|
||||
Args:
|
||||
date: string, Represents the date in yyyy-mm-dd format for which the data is to be fetched. (required)
|
||||
pageToken: string, Token to specify next page.
|
||||
parameters: string, Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # JSON template for a collection of usage reports.
|
||||
"nextPageToken": "A String", # Token for retrieving the next page
|
||||
"kind": "admin#reports#usageReports", # The kind of object.
|
||||
"usageReports": [ # Various application parameter records.
|
||||
{ # JSON template for a usage report.
|
||||
"date": "A String", # The date to which the record belongs.
|
||||
"kind": "admin#reports#usageReport", # The kind of object.
|
||||
"parameters": [ # Parameter value pairs for various applications.
|
||||
{
|
||||
"stringValue": "A String", # String value of the parameter.
|
||||
"boolValue": True or False, # Boolean value of the parameter.
|
||||
"datetimeValue": "A String", # RFC 3339 formatted value of the parameter.
|
||||
"intValue": "A String", # Integral value of the parameter.
|
||||
"name": "A String", # The name of the parameter.
|
||||
},
|
||||
],
|
||||
"entity": { # Information about the type of the item.
|
||||
"profileId": "A String", # Obfuscated user id for the record.
|
||||
"userEmail": "A String", # user's email.
|
||||
"type": "A String", # The type of item, can be a customer or user.
|
||||
"customerId": "A String", # Obfuscated customer id for the record.
|
||||
},
|
||||
},
|
||||
],
|
||||
"warnings": [ # Warnings if any.
|
||||
{
|
||||
"message": "A String", # Human readable message for the warning.
|
||||
"code": "A String", # Machine readable code / warning type.
|
||||
"data": [ # Key-Value pairs to give detailed information on the warning.
|
||||
{
|
||||
"value": "A String", # Value associated with a key-value pair to give detailed information on the warning.
|
||||
"key": "A String", # Key associated with a key-value pair to give detailed information on the warning.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get_next">get_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
92
docs/dyn/admin_reports_v1.html
Normal file
92
docs/dyn/admin_reports_v1.html
Normal file
@@ -0,0 +1,92 @@
|
||||
<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="admin_reports_v1.html">Admin Reports API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="admin_reports_v1.activities.html">activities()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the activities Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="admin_reports_v1.customerUsageReports.html">customerUsageReports()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the customerUsageReports Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="admin_reports_v1.userUsageReport.html">userUsageReport()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the userUsageReport Resource.</p>
|
||||
|
||||
</body></html>
|
||||
152
docs/dyn/admin_reports_v1.userUsageReport.html
Normal file
152
docs/dyn/admin_reports_v1.userUsageReport.html
Normal file
@@ -0,0 +1,152 @@
|
||||
<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="admin_reports_v1.html">Admin Reports API</a> . <a href="admin_reports_v1.userUsageReport.html">userUsageReport</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(userKey, date, parameters=None, pageToken=None, filters=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">Retrieves a report which is a collection of properties / statistics for a set of users.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get_next">get_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(userKey, date, parameters=None, pageToken=None, filters=None, maxResults=None)</code>
|
||||
<pre>Retrieves a report which is a collection of properties / statistics for a set of users.
|
||||
|
||||
Args:
|
||||
userKey: string, Represents the profile id or the user email for which the data should be filtered. (required)
|
||||
date: string, Represents the date in yyyy-mm-dd format for which the data is to be fetched. (required)
|
||||
parameters: string, Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
|
||||
pageToken: string, Token to specify next page.
|
||||
filters: string, Represents the set of filters including parameter operator value.
|
||||
maxResults: integer, Maximum number of results to return. Maximum allowed is 1000
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # JSON template for a collection of usage reports.
|
||||
"nextPageToken": "A String", # Token for retrieving the next page
|
||||
"kind": "admin#reports#usageReports", # The kind of object.
|
||||
"usageReports": [ # Various application parameter records.
|
||||
{ # JSON template for a usage report.
|
||||
"date": "A String", # The date to which the record belongs.
|
||||
"kind": "admin#reports#usageReport", # The kind of object.
|
||||
"parameters": [ # Parameter value pairs for various applications.
|
||||
{
|
||||
"stringValue": "A String", # String value of the parameter.
|
||||
"boolValue": True or False, # Boolean value of the parameter.
|
||||
"datetimeValue": "A String", # RFC 3339 formatted value of the parameter.
|
||||
"intValue": "A String", # Integral value of the parameter.
|
||||
"name": "A String", # The name of the parameter.
|
||||
},
|
||||
],
|
||||
"entity": { # Information about the type of the item.
|
||||
"profileId": "A String", # Obfuscated user id for the record.
|
||||
"userEmail": "A String", # user's email.
|
||||
"type": "A String", # The type of item, can be a customer or user.
|
||||
"customerId": "A String", # Obfuscated customer id for the record.
|
||||
},
|
||||
},
|
||||
],
|
||||
"warnings": [ # Warnings if any.
|
||||
{
|
||||
"message": "A String", # Human readable message for the warning.
|
||||
"code": "A String", # Machine readable code / warning type.
|
||||
"data": [ # Key-Value pairs to give detailed information on the warning.
|
||||
{
|
||||
"value": "A String", # Value associated with a key-value pair to give detailed information on the warning.
|
||||
"key": "A String", # Key associated with a key-value pair to give detailed information on the warning.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get_next">get_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
126
docs/dyn/adsense_v1_3.accounts.adclients.html
Normal file
126
docs/dyn/adsense_v1_3.accounts.adclients.html
Normal file
@@ -0,0 +1,126 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.adclients.html">adclients</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(accountId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all ad clients in the specified account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(accountId, pageToken=None, maxResults=None)</code>
|
||||
<pre>List all ad clients in the specified account.
|
||||
|
||||
Args:
|
||||
accountId: string, Account for which to list ad clients. (required)
|
||||
pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The ad clients returned in this list response.
|
||||
{
|
||||
"productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
|
||||
"kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.
|
||||
"id": "A String", # Unique identifier of this ad client.
|
||||
"arcOptIn": True or False, # Whether this ad client is opted in to ARC.
|
||||
"supportsReporting": True or False, # Whether this ad client supports being reported on.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
133
docs/dyn/adsense_v1_3.accounts.adunits.customchannels.html
Normal file
133
docs/dyn/adsense_v1_3.accounts.adunits.customchannels.html
Normal file
@@ -0,0 +1,133 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.adunits.html">adunits</a> . <a href="adsense_v1_3.accounts.adunits.customchannels.html">customchannels</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all custom channels which the specified ad unit belongs to.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)</code>
|
||||
<pre>List all custom channels which the specified ad unit belongs to.
|
||||
|
||||
Args:
|
||||
accountId: string, Account to which the ad client belongs. (required)
|
||||
adClientId: string, Ad client which contains the ad unit. (required)
|
||||
adUnitId: string, Ad unit for which to list custom channels. (required)
|
||||
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The custom channels returned in this list response.
|
||||
{
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
|
||||
"targetingInfo": { # The targeting information of this custom channel, if activated.
|
||||
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
|
||||
"adsAppearOn": "A String", # The name used to describe this channel externally.
|
||||
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
|
||||
"description": "A String", # The external description of the channel.
|
||||
},
|
||||
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"name": "A String", # Name of this custom channel.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
262
docs/dyn/adsense_v1_3.accounts.adunits.html
Normal file
262
docs/dyn/adsense_v1_3.accounts.adunits.html
Normal file
@@ -0,0 +1,262 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.adunits.html">adunits</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.accounts.adunits.customchannels.html">customchannels()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the customchannels Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(accountId, adClientId, adUnitId)</a></code></p>
|
||||
<p class="firstline">Gets the specified ad unit in the specified ad client for the specified account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#getAdCode">getAdCode(accountId, adClientId, adUnitId)</a></code></p>
|
||||
<p class="firstline">Get ad code for the specified ad unit.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all ad units in the specified ad client for the specified account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(accountId, adClientId, adUnitId)</code>
|
||||
<pre>Gets the specified ad unit in the specified ad client for the specified account.
|
||||
|
||||
Args:
|
||||
accountId: string, Account to which the ad client belongs. (required)
|
||||
adClientId: string, Ad client for which to get the ad unit. (required)
|
||||
adUnitId: string, Ad unit to retrieve. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"status": "A String", # Status of this ad unit. Possible values are:
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
|
||||
#
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
|
||||
#
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
|
||||
"name": "A String", # Name of this ad unit.
|
||||
"feedAdsSettings": { # Settings specific to feed ads (AFF).
|
||||
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
|
||||
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
|
||||
"adPosition": "A String", # The position of the ads relative to the feed entries.
|
||||
"type": "A String", # The type of ads which should appear.
|
||||
},
|
||||
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
|
||||
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
|
||||
"type": "A String", # Type of this ad unit.
|
||||
"backupOption": { # The backup option to be used in instances where no ad is available.
|
||||
"color": "A String", # Color to use when type is set to COLOR.
|
||||
"url": "A String", # URL to use when type is set to URL.
|
||||
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
|
||||
},
|
||||
"size": "A String", # Size of this ad unit.
|
||||
},
|
||||
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
|
||||
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
|
||||
"type": "A String", # Type of this ad unit.
|
||||
"markupLanguage": "A String", # The markup language to use for this ad unit.
|
||||
"size": "A String", # Size of this ad unit.
|
||||
},
|
||||
"customStyle": { # Custom style information specific to this ad unit.
|
||||
"corners": "A String", # The style of the corners in the ad.
|
||||
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
|
||||
"url": "A String", # The color of the ad url.
|
||||
"text": "A String", # The color of the ad text.
|
||||
"border": "A String", # The color of the ad border.
|
||||
"background": "A String", # The color of the ad background.
|
||||
"title": "A String", # The color of the ad title.
|
||||
},
|
||||
"font": { # The font which is included in the style.
|
||||
"family": "A String", # The family of the font.
|
||||
"size": "A String", # The size of the font.
|
||||
},
|
||||
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="getAdCode">getAdCode(accountId, adClientId, adUnitId)</code>
|
||||
<pre>Get ad code for the specified ad unit.
|
||||
|
||||
Args:
|
||||
accountId: string, Account which contains the ad client. (required)
|
||||
adClientId: string, Ad client with contains the ad unit. (required)
|
||||
adUnitId: string, Ad unit to get the code for. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"adCode": "A String", # The ad code snippet.
|
||||
"kind": "adsense#adCode", # Kind this is, in this case adsense#adCode.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)</code>
|
||||
<pre>List all ad units in the specified ad client for the specified account.
|
||||
|
||||
Args:
|
||||
accountId: string, Account to which the ad client belongs. (required)
|
||||
adClientId: string, Ad client for which to list ad units. (required)
|
||||
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The ad units returned in this list response.
|
||||
{
|
||||
"status": "A String", # Status of this ad unit. Possible values are:
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
|
||||
#
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
|
||||
#
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
|
||||
"name": "A String", # Name of this ad unit.
|
||||
"feedAdsSettings": { # Settings specific to feed ads (AFF).
|
||||
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
|
||||
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
|
||||
"adPosition": "A String", # The position of the ads relative to the feed entries.
|
||||
"type": "A String", # The type of ads which should appear.
|
||||
},
|
||||
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
|
||||
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
|
||||
"type": "A String", # Type of this ad unit.
|
||||
"backupOption": { # The backup option to be used in instances where no ad is available.
|
||||
"color": "A String", # Color to use when type is set to COLOR.
|
||||
"url": "A String", # URL to use when type is set to URL.
|
||||
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
|
||||
},
|
||||
"size": "A String", # Size of this ad unit.
|
||||
},
|
||||
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
|
||||
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
|
||||
"type": "A String", # Type of this ad unit.
|
||||
"markupLanguage": "A String", # The markup language to use for this ad unit.
|
||||
"size": "A String", # Size of this ad unit.
|
||||
},
|
||||
"customStyle": { # Custom style information specific to this ad unit.
|
||||
"corners": "A String", # The style of the corners in the ad.
|
||||
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
|
||||
"url": "A String", # The color of the ad url.
|
||||
"text": "A String", # The color of the ad text.
|
||||
"border": "A String", # The color of the ad border.
|
||||
"background": "A String", # The color of the ad background.
|
||||
"title": "A String", # The color of the ad title.
|
||||
},
|
||||
"font": { # The font which is included in the style.
|
||||
"family": "A String", # The family of the font.
|
||||
"size": "A String", # The size of the font.
|
||||
},
|
||||
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
|
||||
},
|
||||
},
|
||||
],
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
106
docs/dyn/adsense_v1_3.accounts.alerts.html
Normal file
106
docs/dyn/adsense_v1_3.accounts.alerts.html
Normal file
@@ -0,0 +1,106 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.alerts.html">alerts</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(accountId, locale=None)</a></code></p>
|
||||
<p class="firstline">List the alerts for the specified AdSense account.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(accountId, locale=None)</code>
|
||||
<pre>List the alerts for the specified AdSense account.
|
||||
|
||||
Args:
|
||||
accountId: string, Account for which to retrieve the alerts. (required)
|
||||
locale: string, The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"items": [ # The alerts returned in this list response.
|
||||
{
|
||||
"type": "A String", # Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.
|
||||
"kind": "adsense#alert", # Kind of resource this is, in this case adsense#alert.
|
||||
"message": "A String", # The localized alert message.
|
||||
"id": "A String", # Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"severity": "A String", # Severity of this alert. Possible values: INFO, WARNING, SEVERE.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#alerts", # Kind of list this is, in this case adsense#alerts.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
171
docs/dyn/adsense_v1_3.accounts.customchannels.adunits.html
Normal file
171
docs/dyn/adsense_v1_3.accounts.customchannels.adunits.html
Normal file
@@ -0,0 +1,171 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.customchannels.html">customchannels</a> . <a href="adsense_v1_3.accounts.customchannels.adunits.html">adunits</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all ad units in the specified custom channel.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</code>
|
||||
<pre>List all ad units in the specified custom channel.
|
||||
|
||||
Args:
|
||||
accountId: string, Account to which the ad client belongs. (required)
|
||||
adClientId: string, Ad client which contains the custom channel. (required)
|
||||
customChannelId: string, Custom channel for which to list ad units. (required)
|
||||
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The ad units returned in this list response.
|
||||
{
|
||||
"status": "A String", # Status of this ad unit. Possible values are:
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
|
||||
#
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
|
||||
#
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
|
||||
"name": "A String", # Name of this ad unit.
|
||||
"feedAdsSettings": { # Settings specific to feed ads (AFF).
|
||||
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
|
||||
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
|
||||
"adPosition": "A String", # The position of the ads relative to the feed entries.
|
||||
"type": "A String", # The type of ads which should appear.
|
||||
},
|
||||
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
|
||||
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
|
||||
"type": "A String", # Type of this ad unit.
|
||||
"backupOption": { # The backup option to be used in instances where no ad is available.
|
||||
"color": "A String", # Color to use when type is set to COLOR.
|
||||
"url": "A String", # URL to use when type is set to URL.
|
||||
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
|
||||
},
|
||||
"size": "A String", # Size of this ad unit.
|
||||
},
|
||||
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
|
||||
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
|
||||
"type": "A String", # Type of this ad unit.
|
||||
"markupLanguage": "A String", # The markup language to use for this ad unit.
|
||||
"size": "A String", # Size of this ad unit.
|
||||
},
|
||||
"customStyle": { # Custom style information specific to this ad unit.
|
||||
"corners": "A String", # The style of the corners in the ad.
|
||||
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
|
||||
"url": "A String", # The color of the ad url.
|
||||
"text": "A String", # The color of the ad text.
|
||||
"border": "A String", # The color of the ad border.
|
||||
"background": "A String", # The color of the ad background.
|
||||
"title": "A String", # The color of the ad title.
|
||||
},
|
||||
"font": { # The font which is included in the style.
|
||||
"family": "A String", # The family of the font.
|
||||
"size": "A String", # The size of the font.
|
||||
},
|
||||
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
|
||||
},
|
||||
},
|
||||
],
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
166
docs/dyn/adsense_v1_3.accounts.customchannels.html
Normal file
166
docs/dyn/adsense_v1_3.accounts.customchannels.html
Normal file
@@ -0,0 +1,166 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.customchannels.html">customchannels</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.accounts.customchannels.adunits.html">adunits()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the adunits Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(accountId, adClientId, customChannelId)</a></code></p>
|
||||
<p class="firstline">Get the specified custom channel from the specified ad client for the specified account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(accountId, adClientId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all custom channels in the specified ad client for the specified account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(accountId, adClientId, customChannelId)</code>
|
||||
<pre>Get the specified custom channel from the specified ad client for the specified account.
|
||||
|
||||
Args:
|
||||
accountId: string, Account to which the ad client belongs. (required)
|
||||
adClientId: string, Ad client which contains the custom channel. (required)
|
||||
customChannelId: string, Custom channel to retrieve. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
|
||||
"targetingInfo": { # The targeting information of this custom channel, if activated.
|
||||
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
|
||||
"adsAppearOn": "A String", # The name used to describe this channel externally.
|
||||
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
|
||||
"description": "A String", # The external description of the channel.
|
||||
},
|
||||
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"name": "A String", # Name of this custom channel.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(accountId, adClientId, pageToken=None, maxResults=None)</code>
|
||||
<pre>List all custom channels in the specified ad client for the specified account.
|
||||
|
||||
Args:
|
||||
accountId: string, Account to which the ad client belongs. (required)
|
||||
adClientId: string, Ad client for which to list custom channels. (required)
|
||||
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The custom channels returned in this list response.
|
||||
{
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
|
||||
"targetingInfo": { # The targeting information of this custom channel, if activated.
|
||||
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
|
||||
"adsAppearOn": "A String", # The name used to describe this channel externally.
|
||||
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
|
||||
"description": "A String", # The external description of the channel.
|
||||
},
|
||||
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"name": "A String", # Name of this custom channel.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
187
docs/dyn/adsense_v1_3.accounts.html
Normal file
187
docs/dyn/adsense_v1_3.accounts.html
Normal file
@@ -0,0 +1,187 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.accounts.adclients.html">adclients()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the adclients Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.accounts.adunits.html">adunits()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the adunits Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.accounts.alerts.html">alerts()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the alerts Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.accounts.customchannels.html">customchannels()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the customchannels Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.accounts.reports.html">reports()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the reports Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.accounts.savedadstyles.html">savedadstyles()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the savedadstyles Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.accounts.urlchannels.html">urlchannels()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the urlchannels Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(accountId, tree=None)</a></code></p>
|
||||
<p class="firstline">Get information about the selected AdSense account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all accounts available to this AdSense account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(accountId, tree=None)</code>
|
||||
<pre>Get information about the selected AdSense account.
|
||||
|
||||
Args:
|
||||
accountId: string, Account to get information about. (required)
|
||||
tree: boolean, Whether the tree of sub accounts should be returned.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "adsense#account", # Kind of resource this is, in this case adsense#account.
|
||||
"premium": True or False, # Whether this account is premium.
|
||||
"id": "A String", # Unique identifier of this account.
|
||||
"subAccounts": [ # Sub accounts of the this account.
|
||||
# Object with schema name: Account
|
||||
],
|
||||
"name": "A String", # Name of this account.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
|
||||
<pre>List all accounts available to this AdSense account.
|
||||
|
||||
Args:
|
||||
pageToken: string, A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of accounts to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The accounts returned in this list response.
|
||||
{
|
||||
"kind": "adsense#account", # Kind of resource this is, in this case adsense#account.
|
||||
"premium": True or False, # Whether this account is premium.
|
||||
"id": "A String", # Unique identifier of this account.
|
||||
"subAccounts": [ # Sub accounts of the this account.
|
||||
# Object with schema name: Account
|
||||
],
|
||||
"name": "A String", # Name of this account.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#accounts", # Kind of list this is, in this case adsense#accounts.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
161
docs/dyn/adsense_v1_3.accounts.reports.html
Normal file
161
docs/dyn/adsense_v1_3.accounts.reports.html
Normal file
@@ -0,0 +1,161 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.reports.html">reports</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.accounts.reports.saved.html">saved()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the saved Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="#generate">generate(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p>
|
||||
<p class="firstline">Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#generate_media">generate_media(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p>
|
||||
<p class="firstline">Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="generate">generate(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</code>
|
||||
<pre>Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
|
||||
|
||||
Args:
|
||||
accountId: string, Account upon which to report. (required)
|
||||
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
|
||||
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
|
||||
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
|
||||
metric: string, Numeric columns to include in the report. (repeated)
|
||||
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
|
||||
startIndex: integer, Index of the first row of report data to return.
|
||||
useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
|
||||
sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
|
||||
maxResults: integer, The maximum number of rows of report data to return.
|
||||
filter: string, Filters to be run on the report. (repeated)
|
||||
dimension: string, Dimensions to base the report on. (repeated)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "adsense#report", # Kind this is, in this case adsense#report.
|
||||
"rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
|
||||
[
|
||||
"A String",
|
||||
],
|
||||
],
|
||||
"warnings": [ # Any warnings associated with generation of the report.
|
||||
"A String",
|
||||
],
|
||||
"totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
|
||||
"A String",
|
||||
],
|
||||
"headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
|
||||
{
|
||||
"currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
|
||||
"type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
|
||||
"name": "A String", # The name of the header.
|
||||
},
|
||||
],
|
||||
"totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
|
||||
"averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
|
||||
"A String",
|
||||
],
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="generate_media">generate_media(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</code>
|
||||
<pre>Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
|
||||
|
||||
Args:
|
||||
accountId: string, Account upon which to report. (required)
|
||||
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
|
||||
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
|
||||
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
|
||||
metric: string, Numeric columns to include in the report. (repeated)
|
||||
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
|
||||
startIndex: integer, Index of the first row of report data to return.
|
||||
useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
|
||||
sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
|
||||
maxResults: integer, The maximum number of rows of report data to return.
|
||||
filter: string, Filters to be run on the report. (repeated)
|
||||
dimension: string, Dimensions to base the report on. (repeated)
|
||||
|
||||
Returns:
|
||||
The media object as a string.
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
168
docs/dyn/adsense_v1_3.accounts.reports.saved.html
Normal file
168
docs/dyn/adsense_v1_3.accounts.reports.saved.html
Normal file
@@ -0,0 +1,168 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.reports.html">reports</a> . <a href="adsense_v1_3.accounts.reports.saved.html">saved</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#generate">generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)</a></code></p>
|
||||
<p class="firstline">Generate an AdSense report based on the saved report ID sent in the query parameters.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(accountId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all saved reports in the specified AdSense account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="generate">generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)</code>
|
||||
<pre>Generate an AdSense report based on the saved report ID sent in the query parameters.
|
||||
|
||||
Args:
|
||||
accountId: string, Account to which the saved reports belong. (required)
|
||||
savedReportId: string, The saved report to retrieve. (required)
|
||||
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
|
||||
maxResults: integer, The maximum number of rows of report data to return.
|
||||
startIndex: integer, Index of the first row of report data to return.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "adsense#report", # Kind this is, in this case adsense#report.
|
||||
"rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
|
||||
[
|
||||
"A String",
|
||||
],
|
||||
],
|
||||
"warnings": [ # Any warnings associated with generation of the report.
|
||||
"A String",
|
||||
],
|
||||
"totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
|
||||
"A String",
|
||||
],
|
||||
"headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
|
||||
{
|
||||
"currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
|
||||
"type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
|
||||
"name": "A String", # The name of the header.
|
||||
},
|
||||
],
|
||||
"totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
|
||||
"averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
|
||||
"A String",
|
||||
],
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(accountId, pageToken=None, maxResults=None)</code>
|
||||
<pre>List all saved reports in the specified AdSense account.
|
||||
|
||||
Args:
|
||||
accountId: string, Account to which the saved reports belong. (required)
|
||||
pageToken: string, A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of saved reports to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The saved reports returned in this list response.
|
||||
{
|
||||
"kind": "adsense#savedReport", # Kind of resource this is, in this case adsense#savedReport.
|
||||
"id": "A String", # Unique identifier of this saved report.
|
||||
"name": "A String", # This saved report's name.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#savedReports", # Kind of list this is, in this case adsense#savedReports.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
175
docs/dyn/adsense_v1_3.accounts.savedadstyles.html
Normal file
175
docs/dyn/adsense_v1_3.accounts.savedadstyles.html
Normal file
@@ -0,0 +1,175 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.savedadstyles.html">savedadstyles</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(accountId, savedAdStyleId)</a></code></p>
|
||||
<p class="firstline">List a specific saved ad style for the specified account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(accountId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all saved ad styles in the specified account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(accountId, savedAdStyleId)</code>
|
||||
<pre>List a specific saved ad style for the specified account.
|
||||
|
||||
Args:
|
||||
accountId: string, Account for which to get the saved ad style. (required)
|
||||
savedAdStyleId: string, Saved ad style to retrieve. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
|
||||
"adStyle": { # The AdStyle itself.
|
||||
"corners": "A String", # The style of the corners in the ad.
|
||||
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
|
||||
"url": "A String", # The color of the ad url.
|
||||
"text": "A String", # The color of the ad text.
|
||||
"border": "A String", # The color of the ad border.
|
||||
"background": "A String", # The color of the ad background.
|
||||
"title": "A String", # The color of the ad title.
|
||||
},
|
||||
"font": { # The font which is included in the style.
|
||||
"family": "A String", # The family of the font.
|
||||
"size": "A String", # The size of the font.
|
||||
},
|
||||
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
|
||||
},
|
||||
"name": "A String", # The user selected name of this SavedAdStyle.
|
||||
"id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(accountId, pageToken=None, maxResults=None)</code>
|
||||
<pre>List all saved ad styles in the specified account.
|
||||
|
||||
Args:
|
||||
accountId: string, Account for which to list saved ad styles. (required)
|
||||
pageToken: string, A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of saved ad styles to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The saved ad styles returned in this list response.
|
||||
{
|
||||
"kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
|
||||
"adStyle": { # The AdStyle itself.
|
||||
"corners": "A String", # The style of the corners in the ad.
|
||||
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
|
||||
"url": "A String", # The color of the ad url.
|
||||
"text": "A String", # The color of the ad text.
|
||||
"border": "A String", # The color of the ad border.
|
||||
"background": "A String", # The color of the ad background.
|
||||
"title": "A String", # The color of the ad title.
|
||||
},
|
||||
"font": { # The font which is included in the style.
|
||||
"family": "A String", # The family of the font.
|
||||
"size": "A String", # The size of the font.
|
||||
},
|
||||
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
|
||||
},
|
||||
"name": "A String", # The user selected name of this SavedAdStyle.
|
||||
"id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#savedAdStyles", # Kind of list this is, in this case adsense#savedAdStyles.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
125
docs/dyn/adsense_v1_3.accounts.urlchannels.html
Normal file
125
docs/dyn/adsense_v1_3.accounts.urlchannels.html
Normal file
@@ -0,0 +1,125 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.urlchannels.html">urlchannels</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(accountId, adClientId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all URL channels in the specified ad client for the specified account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(accountId, adClientId, pageToken=None, maxResults=None)</code>
|
||||
<pre>List all URL channels in the specified ad client for the specified account.
|
||||
|
||||
Args:
|
||||
accountId: string, Account to which the ad client belongs. (required)
|
||||
adClientId: string, Ad client for which to list URL channels. (required)
|
||||
pageToken: string, A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The URL channels returned in this list response.
|
||||
{
|
||||
"kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.
|
||||
"id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
|
||||
},
|
||||
],
|
||||
"kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
125
docs/dyn/adsense_v1_3.adclients.html
Normal file
125
docs/dyn/adsense_v1_3.adclients.html
Normal file
@@ -0,0 +1,125 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.adclients.html">adclients</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all ad clients in this AdSense account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
|
||||
<pre>List all ad clients in this AdSense account.
|
||||
|
||||
Args:
|
||||
pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The ad clients returned in this list response.
|
||||
{
|
||||
"productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
|
||||
"kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.
|
||||
"id": "A String", # Unique identifier of this ad client.
|
||||
"arcOptIn": True or False, # Whether this ad client is opted in to ARC.
|
||||
"supportsReporting": True or False, # Whether this ad client supports being reported on.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
132
docs/dyn/adsense_v1_3.adunits.customchannels.html
Normal file
132
docs/dyn/adsense_v1_3.adunits.customchannels.html
Normal file
@@ -0,0 +1,132 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.adunits.html">adunits</a> . <a href="adsense_v1_3.adunits.customchannels.html">customchannels</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(adClientId, adUnitId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all custom channels which the specified ad unit belongs to.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(adClientId, adUnitId, pageToken=None, maxResults=None)</code>
|
||||
<pre>List all custom channels which the specified ad unit belongs to.
|
||||
|
||||
Args:
|
||||
adClientId: string, Ad client which contains the ad unit. (required)
|
||||
adUnitId: string, Ad unit for which to list custom channels. (required)
|
||||
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The custom channels returned in this list response.
|
||||
{
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
|
||||
"targetingInfo": { # The targeting information of this custom channel, if activated.
|
||||
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
|
||||
"adsAppearOn": "A String", # The name used to describe this channel externally.
|
||||
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
|
||||
"description": "A String", # The external description of the channel.
|
||||
},
|
||||
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"name": "A String", # Name of this custom channel.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
259
docs/dyn/adsense_v1_3.adunits.html
Normal file
259
docs/dyn/adsense_v1_3.adunits.html
Normal file
@@ -0,0 +1,259 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.adunits.html">adunits</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.adunits.customchannels.html">customchannels()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the customchannels Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(adClientId, adUnitId)</a></code></p>
|
||||
<p class="firstline">Gets the specified ad unit in the specified ad client.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#getAdCode">getAdCode(adClientId, adUnitId)</a></code></p>
|
||||
<p class="firstline">Get ad code for the specified ad unit.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(adClientId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all ad units in the specified ad client for this AdSense account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(adClientId, adUnitId)</code>
|
||||
<pre>Gets the specified ad unit in the specified ad client.
|
||||
|
||||
Args:
|
||||
adClientId: string, Ad client for which to get the ad unit. (required)
|
||||
adUnitId: string, Ad unit to retrieve. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"status": "A String", # Status of this ad unit. Possible values are:
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
|
||||
#
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
|
||||
#
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
|
||||
"name": "A String", # Name of this ad unit.
|
||||
"feedAdsSettings": { # Settings specific to feed ads (AFF).
|
||||
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
|
||||
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
|
||||
"adPosition": "A String", # The position of the ads relative to the feed entries.
|
||||
"type": "A String", # The type of ads which should appear.
|
||||
},
|
||||
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
|
||||
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
|
||||
"type": "A String", # Type of this ad unit.
|
||||
"backupOption": { # The backup option to be used in instances where no ad is available.
|
||||
"color": "A String", # Color to use when type is set to COLOR.
|
||||
"url": "A String", # URL to use when type is set to URL.
|
||||
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
|
||||
},
|
||||
"size": "A String", # Size of this ad unit.
|
||||
},
|
||||
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
|
||||
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
|
||||
"type": "A String", # Type of this ad unit.
|
||||
"markupLanguage": "A String", # The markup language to use for this ad unit.
|
||||
"size": "A String", # Size of this ad unit.
|
||||
},
|
||||
"customStyle": { # Custom style information specific to this ad unit.
|
||||
"corners": "A String", # The style of the corners in the ad.
|
||||
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
|
||||
"url": "A String", # The color of the ad url.
|
||||
"text": "A String", # The color of the ad text.
|
||||
"border": "A String", # The color of the ad border.
|
||||
"background": "A String", # The color of the ad background.
|
||||
"title": "A String", # The color of the ad title.
|
||||
},
|
||||
"font": { # The font which is included in the style.
|
||||
"family": "A String", # The family of the font.
|
||||
"size": "A String", # The size of the font.
|
||||
},
|
||||
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="getAdCode">getAdCode(adClientId, adUnitId)</code>
|
||||
<pre>Get ad code for the specified ad unit.
|
||||
|
||||
Args:
|
||||
adClientId: string, Ad client with contains the ad unit. (required)
|
||||
adUnitId: string, Ad unit to get the code for. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"adCode": "A String", # The ad code snippet.
|
||||
"kind": "adsense#adCode", # Kind this is, in this case adsense#adCode.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(adClientId, pageToken=None, includeInactive=None, maxResults=None)</code>
|
||||
<pre>List all ad units in the specified ad client for this AdSense account.
|
||||
|
||||
Args:
|
||||
adClientId: string, Ad client for which to list ad units. (required)
|
||||
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The ad units returned in this list response.
|
||||
{
|
||||
"status": "A String", # Status of this ad unit. Possible values are:
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
|
||||
#
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
|
||||
#
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
|
||||
"name": "A String", # Name of this ad unit.
|
||||
"feedAdsSettings": { # Settings specific to feed ads (AFF).
|
||||
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
|
||||
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
|
||||
"adPosition": "A String", # The position of the ads relative to the feed entries.
|
||||
"type": "A String", # The type of ads which should appear.
|
||||
},
|
||||
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
|
||||
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
|
||||
"type": "A String", # Type of this ad unit.
|
||||
"backupOption": { # The backup option to be used in instances where no ad is available.
|
||||
"color": "A String", # Color to use when type is set to COLOR.
|
||||
"url": "A String", # URL to use when type is set to URL.
|
||||
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
|
||||
},
|
||||
"size": "A String", # Size of this ad unit.
|
||||
},
|
||||
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
|
||||
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
|
||||
"type": "A String", # Type of this ad unit.
|
||||
"markupLanguage": "A String", # The markup language to use for this ad unit.
|
||||
"size": "A String", # Size of this ad unit.
|
||||
},
|
||||
"customStyle": { # Custom style information specific to this ad unit.
|
||||
"corners": "A String", # The style of the corners in the ad.
|
||||
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
|
||||
"url": "A String", # The color of the ad url.
|
||||
"text": "A String", # The color of the ad text.
|
||||
"border": "A String", # The color of the ad border.
|
||||
"background": "A String", # The color of the ad background.
|
||||
"title": "A String", # The color of the ad title.
|
||||
},
|
||||
"font": { # The font which is included in the style.
|
||||
"family": "A String", # The family of the font.
|
||||
"size": "A String", # The size of the font.
|
||||
},
|
||||
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
|
||||
},
|
||||
},
|
||||
],
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
105
docs/dyn/adsense_v1_3.alerts.html
Normal file
105
docs/dyn/adsense_v1_3.alerts.html
Normal file
@@ -0,0 +1,105 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.alerts.html">alerts</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(locale=None)</a></code></p>
|
||||
<p class="firstline">List the alerts for this AdSense account.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(locale=None)</code>
|
||||
<pre>List the alerts for this AdSense account.
|
||||
|
||||
Args:
|
||||
locale: string, The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"items": [ # The alerts returned in this list response.
|
||||
{
|
||||
"type": "A String", # Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.
|
||||
"kind": "adsense#alert", # Kind of resource this is, in this case adsense#alert.
|
||||
"message": "A String", # The localized alert message.
|
||||
"id": "A String", # Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"severity": "A String", # Severity of this alert. Possible values: INFO, WARNING, SEVERE.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#alerts", # Kind of list this is, in this case adsense#alerts.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
170
docs/dyn/adsense_v1_3.customchannels.adunits.html
Normal file
170
docs/dyn/adsense_v1_3.customchannels.adunits.html
Normal file
@@ -0,0 +1,170 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.customchannels.html">customchannels</a> . <a href="adsense_v1_3.customchannels.adunits.html">adunits</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all ad units in the specified custom channel.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</code>
|
||||
<pre>List all ad units in the specified custom channel.
|
||||
|
||||
Args:
|
||||
adClientId: string, Ad client which contains the custom channel. (required)
|
||||
customChannelId: string, Custom channel for which to list ad units. (required)
|
||||
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The ad units returned in this list response.
|
||||
{
|
||||
"status": "A String", # Status of this ad unit. Possible values are:
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
|
||||
#
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
|
||||
#
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
|
||||
"name": "A String", # Name of this ad unit.
|
||||
"feedAdsSettings": { # Settings specific to feed ads (AFF).
|
||||
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
|
||||
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
|
||||
"adPosition": "A String", # The position of the ads relative to the feed entries.
|
||||
"type": "A String", # The type of ads which should appear.
|
||||
},
|
||||
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
|
||||
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
|
||||
"type": "A String", # Type of this ad unit.
|
||||
"backupOption": { # The backup option to be used in instances where no ad is available.
|
||||
"color": "A String", # Color to use when type is set to COLOR.
|
||||
"url": "A String", # URL to use when type is set to URL.
|
||||
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
|
||||
},
|
||||
"size": "A String", # Size of this ad unit.
|
||||
},
|
||||
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
|
||||
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
|
||||
"type": "A String", # Type of this ad unit.
|
||||
"markupLanguage": "A String", # The markup language to use for this ad unit.
|
||||
"size": "A String", # Size of this ad unit.
|
||||
},
|
||||
"customStyle": { # Custom style information specific to this ad unit.
|
||||
"corners": "A String", # The style of the corners in the ad.
|
||||
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
|
||||
"url": "A String", # The color of the ad url.
|
||||
"text": "A String", # The color of the ad text.
|
||||
"border": "A String", # The color of the ad border.
|
||||
"background": "A String", # The color of the ad background.
|
||||
"title": "A String", # The color of the ad title.
|
||||
},
|
||||
"font": { # The font which is included in the style.
|
||||
"family": "A String", # The family of the font.
|
||||
"size": "A String", # The size of the font.
|
||||
},
|
||||
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
|
||||
},
|
||||
},
|
||||
],
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
164
docs/dyn/adsense_v1_3.customchannels.html
Normal file
164
docs/dyn/adsense_v1_3.customchannels.html
Normal file
@@ -0,0 +1,164 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.customchannels.html">customchannels</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.customchannels.adunits.html">adunits()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the adunits Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(adClientId, customChannelId)</a></code></p>
|
||||
<p class="firstline">Get the specified custom channel from the specified ad client.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all custom channels in the specified ad client for this AdSense account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(adClientId, customChannelId)</code>
|
||||
<pre>Get the specified custom channel from the specified ad client.
|
||||
|
||||
Args:
|
||||
adClientId: string, Ad client which contains the custom channel. (required)
|
||||
customChannelId: string, Custom channel to retrieve. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
|
||||
"targetingInfo": { # The targeting information of this custom channel, if activated.
|
||||
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
|
||||
"adsAppearOn": "A String", # The name used to describe this channel externally.
|
||||
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
|
||||
"description": "A String", # The external description of the channel.
|
||||
},
|
||||
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"name": "A String", # Name of this custom channel.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
|
||||
<pre>List all custom channels in the specified ad client for this AdSense account.
|
||||
|
||||
Args:
|
||||
adClientId: string, Ad client for which to list custom channels. (required)
|
||||
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The custom channels returned in this list response.
|
||||
{
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
|
||||
"targetingInfo": { # The targeting information of this custom channel, if activated.
|
||||
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
|
||||
"adsAppearOn": "A String", # The name used to describe this channel externally.
|
||||
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
|
||||
"description": "A String", # The external description of the channel.
|
||||
},
|
||||
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"name": "A String", # Name of this custom channel.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
122
docs/dyn/adsense_v1_3.html
Normal file
122
docs/dyn/adsense_v1_3.html
Normal file
@@ -0,0 +1,122 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.accounts.html">accounts()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the accounts Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.adclients.html">adclients()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the adclients Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.adunits.html">adunits()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the adunits Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.alerts.html">alerts()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the alerts Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.customchannels.html">customchannels()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the customchannels Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.metadata.html">metadata()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the metadata Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.reports.html">reports()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the reports Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.savedadstyles.html">savedadstyles()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the savedadstyles Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.urlchannels.html">urlchannels()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the urlchannels Resource.</p>
|
||||
|
||||
</body></html>
|
||||
116
docs/dyn/adsense_v1_3.metadata.dimensions.html
Normal file
116
docs/dyn/adsense_v1_3.metadata.dimensions.html
Normal file
@@ -0,0 +1,116 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.metadata.html">metadata</a> . <a href="adsense_v1_3.metadata.dimensions.html">dimensions</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list()</a></code></p>
|
||||
<p class="firstline">List the metadata for the dimensions available to this AdSense account.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list()</code>
|
||||
<pre>List the metadata for the dimensions available to this AdSense account.
|
||||
|
||||
Args:
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"items": [
|
||||
{
|
||||
"requiredMetrics": [ # The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
|
||||
"A String",
|
||||
],
|
||||
"kind": "adsense#reportingMetadataEntry", # Kind of resource this is, in this case adsense#reportingMetadataEntry.
|
||||
"compatibleMetrics": [ # The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.
|
||||
"A String",
|
||||
],
|
||||
"requiredDimensions": [ # The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
|
||||
"A String",
|
||||
],
|
||||
"compatibleDimensions": [ # For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.
|
||||
"A String",
|
||||
],
|
||||
"id": "A String", # Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.
|
||||
"supportedProducts": [ # The codes of the projects supported by the dimension or metric this reporting metadata entry describes.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
],
|
||||
"kind": "adsense#metadata", # Kind of list this is, in this case adsense#metadata.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
87
docs/dyn/adsense_v1_3.metadata.html
Normal file
87
docs/dyn/adsense_v1_3.metadata.html
Normal file
@@ -0,0 +1,87 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.metadata.html">metadata</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.metadata.dimensions.html">dimensions()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the dimensions Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.metadata.metrics.html">metrics()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the metrics Resource.</p>
|
||||
|
||||
</body></html>
|
||||
116
docs/dyn/adsense_v1_3.metadata.metrics.html
Normal file
116
docs/dyn/adsense_v1_3.metadata.metrics.html
Normal file
@@ -0,0 +1,116 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.metadata.html">metadata</a> . <a href="adsense_v1_3.metadata.metrics.html">metrics</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list()</a></code></p>
|
||||
<p class="firstline">List the metadata for the metrics available to this AdSense account.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list()</code>
|
||||
<pre>List the metadata for the metrics available to this AdSense account.
|
||||
|
||||
Args:
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"items": [
|
||||
{
|
||||
"requiredMetrics": [ # The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
|
||||
"A String",
|
||||
],
|
||||
"kind": "adsense#reportingMetadataEntry", # Kind of resource this is, in this case adsense#reportingMetadataEntry.
|
||||
"compatibleMetrics": [ # The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.
|
||||
"A String",
|
||||
],
|
||||
"requiredDimensions": [ # The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
|
||||
"A String",
|
||||
],
|
||||
"compatibleDimensions": [ # For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.
|
||||
"A String",
|
||||
],
|
||||
"id": "A String", # Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.
|
||||
"supportedProducts": [ # The codes of the projects supported by the dimension or metric this reporting metadata entry describes.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
],
|
||||
"kind": "adsense#metadata", # Kind of list this is, in this case adsense#metadata.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
161
docs/dyn/adsense_v1_3.reports.html
Normal file
161
docs/dyn/adsense_v1_3.reports.html
Normal file
@@ -0,0 +1,161 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.reports.html">reports</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_3.reports.saved.html">saved()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the saved Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="#generate">generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p>
|
||||
<p class="firstline">Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#generate_media">generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p>
|
||||
<p class="firstline">Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="generate">generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</code>
|
||||
<pre>Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
|
||||
|
||||
Args:
|
||||
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
|
||||
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
|
||||
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
|
||||
metric: string, Numeric columns to include in the report. (repeated)
|
||||
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
|
||||
startIndex: integer, Index of the first row of report data to return.
|
||||
accountId: string, Accounts upon which to report. (repeated)
|
||||
useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
|
||||
sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
|
||||
maxResults: integer, The maximum number of rows of report data to return.
|
||||
filter: string, Filters to be run on the report. (repeated)
|
||||
dimension: string, Dimensions to base the report on. (repeated)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "adsense#report", # Kind this is, in this case adsense#report.
|
||||
"rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
|
||||
[
|
||||
"A String",
|
||||
],
|
||||
],
|
||||
"warnings": [ # Any warnings associated with generation of the report.
|
||||
"A String",
|
||||
],
|
||||
"totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
|
||||
"A String",
|
||||
],
|
||||
"headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
|
||||
{
|
||||
"currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
|
||||
"type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
|
||||
"name": "A String", # The name of the header.
|
||||
},
|
||||
],
|
||||
"totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
|
||||
"averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
|
||||
"A String",
|
||||
],
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="generate_media">generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</code>
|
||||
<pre>Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
|
||||
|
||||
Args:
|
||||
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
|
||||
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
|
||||
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
|
||||
metric: string, Numeric columns to include in the report. (repeated)
|
||||
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
|
||||
startIndex: integer, Index of the first row of report data to return.
|
||||
accountId: string, Accounts upon which to report. (repeated)
|
||||
useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
|
||||
sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
|
||||
maxResults: integer, The maximum number of rows of report data to return.
|
||||
filter: string, Filters to be run on the report. (repeated)
|
||||
dimension: string, Dimensions to base the report on. (repeated)
|
||||
|
||||
Returns:
|
||||
The media object as a string.
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
166
docs/dyn/adsense_v1_3.reports.saved.html
Normal file
166
docs/dyn/adsense_v1_3.reports.saved.html
Normal file
@@ -0,0 +1,166 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.reports.html">reports</a> . <a href="adsense_v1_3.reports.saved.html">saved</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#generate">generate(savedReportId, locale=None, maxResults=None, startIndex=None)</a></code></p>
|
||||
<p class="firstline">Generate an AdSense report based on the saved report ID sent in the query parameters.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all saved reports in this AdSense account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="generate">generate(savedReportId, locale=None, maxResults=None, startIndex=None)</code>
|
||||
<pre>Generate an AdSense report based on the saved report ID sent in the query parameters.
|
||||
|
||||
Args:
|
||||
savedReportId: string, The saved report to retrieve. (required)
|
||||
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
|
||||
maxResults: integer, The maximum number of rows of report data to return.
|
||||
startIndex: integer, Index of the first row of report data to return.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "adsense#report", # Kind this is, in this case adsense#report.
|
||||
"rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
|
||||
[
|
||||
"A String",
|
||||
],
|
||||
],
|
||||
"warnings": [ # Any warnings associated with generation of the report.
|
||||
"A String",
|
||||
],
|
||||
"totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
|
||||
"A String",
|
||||
],
|
||||
"headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
|
||||
{
|
||||
"currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
|
||||
"type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
|
||||
"name": "A String", # The name of the header.
|
||||
},
|
||||
],
|
||||
"totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
|
||||
"averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
|
||||
"A String",
|
||||
],
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
|
||||
<pre>List all saved reports in this AdSense account.
|
||||
|
||||
Args:
|
||||
pageToken: string, A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of saved reports to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The saved reports returned in this list response.
|
||||
{
|
||||
"kind": "adsense#savedReport", # Kind of resource this is, in this case adsense#savedReport.
|
||||
"id": "A String", # Unique identifier of this saved report.
|
||||
"name": "A String", # This saved report's name.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#savedReports", # Kind of list this is, in this case adsense#savedReports.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
173
docs/dyn/adsense_v1_3.savedadstyles.html
Normal file
173
docs/dyn/adsense_v1_3.savedadstyles.html
Normal file
@@ -0,0 +1,173 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.savedadstyles.html">savedadstyles</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(savedAdStyleId)</a></code></p>
|
||||
<p class="firstline">Get a specific saved ad style from the user's account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all saved ad styles in the user's account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(savedAdStyleId)</code>
|
||||
<pre>Get a specific saved ad style from the user's account.
|
||||
|
||||
Args:
|
||||
savedAdStyleId: string, Saved ad style to retrieve. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
|
||||
"adStyle": { # The AdStyle itself.
|
||||
"corners": "A String", # The style of the corners in the ad.
|
||||
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
|
||||
"url": "A String", # The color of the ad url.
|
||||
"text": "A String", # The color of the ad text.
|
||||
"border": "A String", # The color of the ad border.
|
||||
"background": "A String", # The color of the ad background.
|
||||
"title": "A String", # The color of the ad title.
|
||||
},
|
||||
"font": { # The font which is included in the style.
|
||||
"family": "A String", # The family of the font.
|
||||
"size": "A String", # The size of the font.
|
||||
},
|
||||
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
|
||||
},
|
||||
"name": "A String", # The user selected name of this SavedAdStyle.
|
||||
"id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
|
||||
<pre>List all saved ad styles in the user's account.
|
||||
|
||||
Args:
|
||||
pageToken: string, A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of saved ad styles to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The saved ad styles returned in this list response.
|
||||
{
|
||||
"kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
|
||||
"adStyle": { # The AdStyle itself.
|
||||
"corners": "A String", # The style of the corners in the ad.
|
||||
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
|
||||
"url": "A String", # The color of the ad url.
|
||||
"text": "A String", # The color of the ad text.
|
||||
"border": "A String", # The color of the ad border.
|
||||
"background": "A String", # The color of the ad background.
|
||||
"title": "A String", # The color of the ad title.
|
||||
},
|
||||
"font": { # The font which is included in the style.
|
||||
"family": "A String", # The family of the font.
|
||||
"size": "A String", # The size of the font.
|
||||
},
|
||||
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
|
||||
},
|
||||
"name": "A String", # The user selected name of this SavedAdStyle.
|
||||
"id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#savedAdStyles", # Kind of list this is, in this case adsense#savedAdStyles.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
124
docs/dyn/adsense_v1_3.urlchannels.html
Normal file
124
docs/dyn/adsense_v1_3.urlchannels.html
Normal file
@@ -0,0 +1,124 @@
|
||||
<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="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.urlchannels.html">urlchannels</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List all URL channels in the specified ad client for this AdSense account.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
|
||||
<pre>List all URL channels in the specified ad client for this AdSense account.
|
||||
|
||||
Args:
|
||||
adClientId: string, Ad client for which to list URL channels. (required)
|
||||
pageToken: string, A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
||||
maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # The URL channels returned in this list response.
|
||||
{
|
||||
"kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.
|
||||
"id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
|
||||
},
|
||||
],
|
||||
"kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
@@ -76,14 +76,14 @@ h1, h2, h3 {
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, segment=None, start_index=None)</a></code></p>
|
||||
<p class="firstline">Returns Analytics data for a profile.</p>
|
||||
<p class="firstline">Returns Analytics data for a view (profile).</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, segment=None, start_index=None)</code>
|
||||
<pre>Returns Analytics data for a profile.
|
||||
<pre>Returns Analytics data for a view (profile).
|
||||
|
||||
Args:
|
||||
ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics profile ID. (required)
|
||||
ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. (required)
|
||||
start_date: string, Start date for fetching Analytics data. All requests should specify a start date formatted as YYYY-MM-DD. (required)
|
||||
end_date: string, End date for fetching Analytics data. All requests should specify an end date formatted as YYYY-MM-DD. (required)
|
||||
metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified. (required)
|
||||
@@ -97,7 +97,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Analytics data for a given profile.
|
||||
{ # Analytics data for a given view (profile).
|
||||
"kind": "analytics#gaData", # Resource type.
|
||||
"rows": [ # Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
|
||||
[
|
||||
@@ -129,13 +129,13 @@ Returns:
|
||||
"end-date": "A String", # End date.
|
||||
},
|
||||
"previousLink": "A String", # Link to previous page for this Analytics data query.
|
||||
"profileInfo": { # Information for the profile, for which the Analytics data was requested.
|
||||
"webPropertyId": "A String", # Web Property ID to which this profile belongs.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this profile belongs.
|
||||
"tableId": "A String", # Table ID for profile.
|
||||
"profileId": "A String", # Profile ID.
|
||||
"profileName": "A String", # Profile name.
|
||||
"accountId": "A String", # Account ID to which this profile belongs.
|
||||
"profileInfo": { # Information for the view (profile), for which the Analytics data was requested.
|
||||
"webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
|
||||
"tableId": "A String", # Table ID for view (profile).
|
||||
"profileId": "A String", # View (Profile) ID.
|
||||
"profileName": "A String", # View (Profile) name.
|
||||
"accountId": "A String", # Account ID to which this view (profile) belongs.
|
||||
},
|
||||
"columnHeaders": [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
|
||||
{
|
||||
|
||||
@@ -84,4 +84,9 @@ h1, h2, h3 {
|
||||
</p>
|
||||
<p class="firstline">Returns the mcf Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="analytics_v3.data.realtime.html">realtime()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the realtime Resource.</p>
|
||||
|
||||
</body></html>
|
||||
@@ -76,14 +76,14 @@ h1, h2, h3 {
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)</a></code></p>
|
||||
<p class="firstline">Returns Analytics Multi-Channel Funnels data for a profile.</p>
|
||||
<p class="firstline">Returns Analytics Multi-Channel Funnels data for a view (profile).</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)</code>
|
||||
<pre>Returns Analytics Multi-Channel Funnels data for a profile.
|
||||
<pre>Returns Analytics Multi-Channel Funnels data for a view (profile).
|
||||
|
||||
Args:
|
||||
ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics profile ID. (required)
|
||||
ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. (required)
|
||||
start_date: string, Start date for fetching Analytics data. All requests should specify a start date formatted as YYYY-MM-DD. (required)
|
||||
end_date: string, End date for fetching Analytics data. All requests should specify an end date formatted as YYYY-MM-DD. (required)
|
||||
metrics: string, A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified. (required)
|
||||
@@ -96,7 +96,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Multi-Channel Funnels data for a given profile.
|
||||
{ # Multi-Channel Funnels data for a given view (profile).
|
||||
"kind": "analytics#mcfData", # Resource type.
|
||||
"rows": [ # Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
|
||||
[
|
||||
@@ -136,13 +136,13 @@ Returns:
|
||||
"end-date": "A String", # End date.
|
||||
},
|
||||
"previousLink": "A String", # Link to previous page for this Analytics data query.
|
||||
"profileInfo": { # Information for the profile, for which the Analytics data was requested.
|
||||
"webPropertyId": "A String", # Web Property ID to which this profile belongs.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this profile belongs.
|
||||
"tableId": "A String", # Table ID for profile.
|
||||
"profileId": "A String", # Profile ID.
|
||||
"profileName": "A String", # Profile name.
|
||||
"accountId": "A String", # Account ID to which this profile belongs.
|
||||
"profileInfo": { # Information for the view (profile), for which the Analytics data was requested.
|
||||
"webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
|
||||
"tableId": "A String", # Table ID for view (profile).
|
||||
"profileId": "A String", # View (Profile) ID.
|
||||
"profileName": "A String", # View (Profile) name.
|
||||
"accountId": "A String", # Account ID to which this view (profile) belongs.
|
||||
},
|
||||
"columnHeaders": [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
|
||||
{
|
||||
|
||||
139
docs/dyn/analytics_v3.data.realtime.html
Normal file
139
docs/dyn/analytics_v3.data.realtime.html
Normal file
@@ -0,0 +1,139 @@
|
||||
<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="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.data.html">data</a> . <a href="analytics_v3.data.realtime.html">realtime</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(ids, metrics, sort=None, dimensions=None, filters=None, max_results=None)</a></code></p>
|
||||
<p class="firstline">Returns real-time data for a view (profile).</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(ids, metrics, sort=None, dimensions=None, filters=None, max_results=None)</code>
|
||||
<pre>Returns real-time data for a view (profile).
|
||||
|
||||
Args:
|
||||
ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. (required)
|
||||
metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified. (required)
|
||||
sort: string, A comma-separated list of dimensions or metrics that determine the sort order for real-time data.
|
||||
dimensions: string, A comma-separated list of real-time dimensions. E.g., 'ga:medium,ga:city'.
|
||||
filters: string, A comma-separated list of dimension or metric filters to be applied to real-time data.
|
||||
max_results: integer, The maximum number of entries to include in this feed.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Real time data for a given view (profile).
|
||||
"kind": "analytics#realtimeData", # Resource type.
|
||||
"rows": [ # Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
|
||||
[
|
||||
"A String",
|
||||
],
|
||||
],
|
||||
"totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
|
||||
"totalsForAllResults": { # Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.
|
||||
"a_key": "A String", # Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.
|
||||
},
|
||||
"id": "A String", # Unique ID for this data response.
|
||||
"query": { # Real time data request query parameters.
|
||||
"max-results": 42, # Maximum results per page.
|
||||
"sort": [ # List of dimensions or metrics based on which real time data is sorted.
|
||||
"A String",
|
||||
],
|
||||
"dimensions": "A String", # List of real time dimensions.
|
||||
"ids": "A String", # Unique table ID.
|
||||
"metrics": [ # List of real time metrics.
|
||||
"A String",
|
||||
],
|
||||
"filters": "A String", # Comma-separated list of dimension or metric filters.
|
||||
},
|
||||
"profileInfo": { # Information for the view (profile), for which the real time data was requested.
|
||||
"webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
|
||||
"tableId": "A String", # Table ID for view (profile).
|
||||
"profileId": "A String", # View (Profile) ID.
|
||||
"profileName": "A String", # View (Profile) name.
|
||||
"accountId": "A String", # Account ID to which this view (profile) belongs.
|
||||
},
|
||||
"columnHeaders": [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
|
||||
{
|
||||
"dataType": "A String", # Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.
|
||||
"columnType": "A String", # Column Type. Either DIMENSION or METRIC.
|
||||
"name": "A String", # Column name.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # Link to this page.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -99,20 +99,21 @@ Returns:
|
||||
"kind": "analytics#customDataSource", # Resource type for Analytics custom data source.
|
||||
"description": "A String", # Description of custom data source.
|
||||
"created": "A String", # Time this custom data source was created.
|
||||
"profilesLinked": [
|
||||
"profilesLinked": [ # IDs of views (profiles) linked to the custom data source.
|
||||
"A String",
|
||||
],
|
||||
"updated": "A String", # Time this custom data source was last modified.
|
||||
"name": "A String", # Name of this custom data source.
|
||||
"childLink": { # Child link for this custom data source. Points to the list of daily uploads for this custom data source.
|
||||
"href": "A String", # Link to the list of daily uploads for this custom data source.
|
||||
"type": "analytics#dailyUploads", # Value is "analytics#dailyUploads".
|
||||
"childLink": {
|
||||
"href": "A String", # Link to the list of daily uploads for this custom data source. Link to the list of uploads for this custom data source.
|
||||
"type": "A String", # Value is "analytics#dailyUploads". Value is "analytics#uploads".
|
||||
},
|
||||
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this custom data source belongs.
|
||||
"parentLink": { # Parent link for this custom data source. Points to the web property to which this custom data source belongs.
|
||||
"href": "A String", # Link to the web property to which this custom data source belongs.
|
||||
"type": "analytics#webproperty", # Value is "analytics#webproperty".
|
||||
},
|
||||
"type": "A String", # Type of the custom data source.
|
||||
"id": "A String", # Custom data source ID.
|
||||
"selfLink": "A String", # Link for this Analytics custom data source.
|
||||
"accountId": "A String", # Account ID to which this custom data source belongs.
|
||||
|
||||
@@ -122,8 +122,8 @@ Returns:
|
||||
{ # Metadata for daily upload entity.
|
||||
"recentChanges": [ # Change log for last 10 changes in chronological order.
|
||||
{
|
||||
"change": "A String",
|
||||
"time": "A String",
|
||||
"change": "A String", # The type of change: APPEND, RESET, or DELETE.
|
||||
"time": "A String", # The time when the change occurred.
|
||||
},
|
||||
],
|
||||
"kind": "analytics#dailyUpload", # Resource type for Analytics daily upload.
|
||||
|
||||
550
docs/dyn/analytics_v3.management.experiments.html
Normal file
550
docs/dyn/analytics_v3.management.experiments.html
Normal file
@@ -0,0 +1,550 @@
|
||||
<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="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.experiments.html">experiments</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(accountId, webPropertyId, profileId, experimentId)</a></code></p>
|
||||
<p class="firstline">Delete an experiment.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(accountId, webPropertyId, profileId, experimentId)</a></code></p>
|
||||
<p class="firstline">Returns an experiment to which the user has access.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(accountId, webPropertyId, profileId, body)</a></code></p>
|
||||
<p class="firstline">Create a new experiment.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</a></code></p>
|
||||
<p class="firstline">Lists experiments to which the user has access.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#patch">patch(accountId, webPropertyId, profileId, experimentId, body)</a></code></p>
|
||||
<p class="firstline">Update an existing experiment. This method supports patch semantics.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(accountId, webPropertyId, profileId, experimentId, body)</a></code></p>
|
||||
<p class="firstline">Update an existing experiment.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(accountId, webPropertyId, profileId, experimentId)</code>
|
||||
<pre>Delete an experiment.
|
||||
|
||||
Args:
|
||||
accountId: string, Account ID to which the experiment belongs (required)
|
||||
webPropertyId: string, Web property ID to which the experiment belongs (required)
|
||||
profileId: string, View (Profile) ID to which the experiment belongs (required)
|
||||
experimentId: string, ID of the experiment to delete (required)
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(accountId, webPropertyId, profileId, experimentId)</code>
|
||||
<pre>Returns an experiment to which the user has access.
|
||||
|
||||
Args:
|
||||
accountId: string, Account ID to retrieve the experiment for. (required)
|
||||
webPropertyId: string, Web property ID to retrieve the experiment for. (required)
|
||||
profileId: string, View (Profile) ID to retrieve the experiment for. (required)
|
||||
experimentId: string, Experiment ID to retrieve the experiment for. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # JSON template for Analytics experiment resource.
|
||||
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
|
||||
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
|
||||
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
|
||||
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
|
||||
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
|
||||
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
|
||||
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
|
||||
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
|
||||
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
|
||||
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
|
||||
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
|
||||
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
|
||||
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
|
||||
"updated": "A String", # Time the experiment was last modified. This field is read-only.
|
||||
"description": "A String", # Notes about this experiment.
|
||||
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
|
||||
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
|
||||
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
|
||||
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
|
||||
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
|
||||
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
|
||||
"created": "A String", # Time the experiment was created. This field is read-only.
|
||||
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
|
||||
{
|
||||
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
|
||||
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
|
||||
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
|
||||
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
|
||||
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
|
||||
},
|
||||
],
|
||||
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
|
||||
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
|
||||
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
|
||||
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
|
||||
},
|
||||
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
|
||||
"selfLink": "A String", # Link for this experiment. This field is read-only.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(accountId, webPropertyId, profileId, body)</code>
|
||||
<pre>Create a new experiment.
|
||||
|
||||
Args:
|
||||
accountId: string, Account ID to create the experiment for. (required)
|
||||
webPropertyId: string, Web property ID to create the experiment for. (required)
|
||||
profileId: string, View (Profile) ID to create the experiment for. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # JSON template for Analytics experiment resource.
|
||||
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
|
||||
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
|
||||
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
|
||||
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
|
||||
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
|
||||
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
|
||||
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
|
||||
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
|
||||
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
|
||||
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
|
||||
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
|
||||
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
|
||||
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
|
||||
"updated": "A String", # Time the experiment was last modified. This field is read-only.
|
||||
"description": "A String", # Notes about this experiment.
|
||||
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
|
||||
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
|
||||
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
|
||||
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
|
||||
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
|
||||
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
|
||||
"created": "A String", # Time the experiment was created. This field is read-only.
|
||||
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
|
||||
{
|
||||
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
|
||||
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
|
||||
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
|
||||
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
|
||||
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
|
||||
},
|
||||
],
|
||||
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
|
||||
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
|
||||
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
|
||||
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
|
||||
},
|
||||
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
|
||||
"selfLink": "A String", # Link for this experiment. This field is read-only.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # JSON template for Analytics experiment resource.
|
||||
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
|
||||
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
|
||||
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
|
||||
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
|
||||
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
|
||||
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
|
||||
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
|
||||
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
|
||||
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
|
||||
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
|
||||
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
|
||||
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
|
||||
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
|
||||
"updated": "A String", # Time the experiment was last modified. This field is read-only.
|
||||
"description": "A String", # Notes about this experiment.
|
||||
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
|
||||
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
|
||||
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
|
||||
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
|
||||
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
|
||||
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
|
||||
"created": "A String", # Time the experiment was created. This field is read-only.
|
||||
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
|
||||
{
|
||||
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
|
||||
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
|
||||
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
|
||||
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
|
||||
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
|
||||
},
|
||||
],
|
||||
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
|
||||
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
|
||||
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
|
||||
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
|
||||
},
|
||||
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
|
||||
"selfLink": "A String", # Link for this experiment. This field is read-only.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code>
|
||||
<pre>Lists experiments to which the user has access.
|
||||
|
||||
Args:
|
||||
accountId: string, Account ID to retrieve experiments for. (required)
|
||||
webPropertyId: string, Web property ID to retrieve experiments for. (required)
|
||||
profileId: string, View (Profile) ID to retrieve experiments for. (required)
|
||||
max_results: integer, The maximum number of experiments to include in this response.
|
||||
start_index: integer, An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment.
|
||||
"username": "A String", # Email ID of the authenticated user
|
||||
"kind": "analytics#experiments", # Collection type.
|
||||
"items": [ # A list of experiments.
|
||||
{ # JSON template for Analytics experiment resource.
|
||||
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
|
||||
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
|
||||
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
|
||||
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
|
||||
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
|
||||
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
|
||||
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
|
||||
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
|
||||
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
|
||||
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
|
||||
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
|
||||
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
|
||||
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
|
||||
"updated": "A String", # Time the experiment was last modified. This field is read-only.
|
||||
"description": "A String", # Notes about this experiment.
|
||||
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
|
||||
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
|
||||
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
|
||||
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
|
||||
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
|
||||
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
|
||||
"created": "A String", # Time the experiment was created. This field is read-only.
|
||||
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
|
||||
{
|
||||
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
|
||||
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
|
||||
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
|
||||
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
|
||||
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
|
||||
},
|
||||
],
|
||||
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
|
||||
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
|
||||
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
|
||||
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
|
||||
},
|
||||
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
|
||||
"selfLink": "A String", # Link for this experiment. This field is read-only.
|
||||
},
|
||||
],
|
||||
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
|
||||
"previousLink": "A String", # Link to previous page for this experiment collection.
|
||||
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
|
||||
"nextLink": "A String", # Link to next page for this experiment collection.
|
||||
"totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="patch">patch(accountId, webPropertyId, profileId, experimentId, body)</code>
|
||||
<pre>Update an existing experiment. This method supports patch semantics.
|
||||
|
||||
Args:
|
||||
accountId: string, Account ID of the experiment to update. (required)
|
||||
webPropertyId: string, Web property ID of the experiment to update. (required)
|
||||
profileId: string, View (Profile) ID of the experiment to update. (required)
|
||||
experimentId: string, Experiment ID of the experiment to update. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # JSON template for Analytics experiment resource.
|
||||
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
|
||||
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
|
||||
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
|
||||
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
|
||||
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
|
||||
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
|
||||
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
|
||||
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
|
||||
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
|
||||
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
|
||||
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
|
||||
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
|
||||
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
|
||||
"updated": "A String", # Time the experiment was last modified. This field is read-only.
|
||||
"description": "A String", # Notes about this experiment.
|
||||
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
|
||||
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
|
||||
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
|
||||
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
|
||||
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
|
||||
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
|
||||
"created": "A String", # Time the experiment was created. This field is read-only.
|
||||
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
|
||||
{
|
||||
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
|
||||
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
|
||||
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
|
||||
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
|
||||
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
|
||||
},
|
||||
],
|
||||
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
|
||||
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
|
||||
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
|
||||
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
|
||||
},
|
||||
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
|
||||
"selfLink": "A String", # Link for this experiment. This field is read-only.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # JSON template for Analytics experiment resource.
|
||||
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
|
||||
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
|
||||
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
|
||||
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
|
||||
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
|
||||
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
|
||||
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
|
||||
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
|
||||
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
|
||||
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
|
||||
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
|
||||
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
|
||||
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
|
||||
"updated": "A String", # Time the experiment was last modified. This field is read-only.
|
||||
"description": "A String", # Notes about this experiment.
|
||||
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
|
||||
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
|
||||
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
|
||||
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
|
||||
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
|
||||
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
|
||||
"created": "A String", # Time the experiment was created. This field is read-only.
|
||||
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
|
||||
{
|
||||
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
|
||||
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
|
||||
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
|
||||
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
|
||||
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
|
||||
},
|
||||
],
|
||||
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
|
||||
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
|
||||
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
|
||||
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
|
||||
},
|
||||
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
|
||||
"selfLink": "A String", # Link for this experiment. This field is read-only.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="update">update(accountId, webPropertyId, profileId, experimentId, body)</code>
|
||||
<pre>Update an existing experiment.
|
||||
|
||||
Args:
|
||||
accountId: string, Account ID of the experiment to update. (required)
|
||||
webPropertyId: string, Web property ID of the experiment to update. (required)
|
||||
profileId: string, View (Profile) ID of the experiment to update. (required)
|
||||
experimentId: string, Experiment ID of the experiment to update. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # JSON template for Analytics experiment resource.
|
||||
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
|
||||
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
|
||||
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
|
||||
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
|
||||
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
|
||||
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
|
||||
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
|
||||
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
|
||||
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
|
||||
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
|
||||
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
|
||||
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
|
||||
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
|
||||
"updated": "A String", # Time the experiment was last modified. This field is read-only.
|
||||
"description": "A String", # Notes about this experiment.
|
||||
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
|
||||
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
|
||||
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
|
||||
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
|
||||
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
|
||||
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
|
||||
"created": "A String", # Time the experiment was created. This field is read-only.
|
||||
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
|
||||
{
|
||||
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
|
||||
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
|
||||
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
|
||||
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
|
||||
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
|
||||
},
|
||||
],
|
||||
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
|
||||
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
|
||||
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
|
||||
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
|
||||
},
|
||||
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
|
||||
"selfLink": "A String", # Link for this experiment. This field is read-only.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # JSON template for Analytics experiment resource.
|
||||
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
|
||||
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
|
||||
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
|
||||
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
|
||||
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
|
||||
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
|
||||
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
|
||||
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
|
||||
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
|
||||
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
|
||||
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
|
||||
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
|
||||
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
|
||||
"updated": "A String", # Time the experiment was last modified. This field is read-only.
|
||||
"description": "A String", # Notes about this experiment.
|
||||
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
|
||||
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
|
||||
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
|
||||
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
|
||||
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
|
||||
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
|
||||
"created": "A String", # Time the experiment was created. This field is read-only.
|
||||
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
|
||||
{
|
||||
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
|
||||
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
|
||||
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
|
||||
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
|
||||
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
|
||||
},
|
||||
],
|
||||
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
|
||||
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
|
||||
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
|
||||
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
|
||||
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
|
||||
},
|
||||
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
|
||||
"selfLink": "A String", # Link for this experiment. This field is read-only.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -85,14 +85,14 @@ h1, h2, h3 {
|
||||
Args:
|
||||
accountId: string, Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. (required)
|
||||
webPropertyId: string, Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. (required)
|
||||
profileId: string, Profile ID to retrieve goals for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. (required)
|
||||
profileId: string, View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. (required)
|
||||
max_results: integer, The maximum number of goals to include in this response.
|
||||
start_index: integer, An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A goal collection lists Analytics goals to which the user has access. Each profile can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.
|
||||
{ # A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.
|
||||
"username": "A String", # Email ID of the authenticated user
|
||||
"kind": "analytics#goals", # Collection type.
|
||||
"items": [ # A list of goals.
|
||||
@@ -138,9 +138,9 @@ Returns:
|
||||
},
|
||||
"webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
|
||||
"active": True or False, # Determines whether this goal is active.
|
||||
"profileId": "A String", # Profile ID to which this goal belongs.
|
||||
"parentLink": { # Parent link for a goal. Points to the profile to which this goal belongs.
|
||||
"href": "A String", # Link to the profile to which this goal belongs.
|
||||
"profileId": "A String", # View (Profile) ID to which this goal belongs.
|
||||
"parentLink": { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
|
||||
"href": "A String", # Link to the view (profile) to which this goal belongs.
|
||||
"type": "analytics#profile", # Value is "analytics#profile".
|
||||
},
|
||||
"type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
|
||||
|
||||
@@ -89,6 +89,11 @@ h1, h2, h3 {
|
||||
</p>
|
||||
<p class="firstline">Returns the dailyUploads Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="analytics_v3.management.experiments.html">experiments()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the experiments Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="analytics_v3.management.goals.html">goals()</a></code>
|
||||
</p>
|
||||
|
||||
@@ -76,58 +76,58 @@ h1, h2, h3 {
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p>
|
||||
<p class="firstline">Lists profiles to which the user has access.</p>
|
||||
<p class="firstline">Lists views (profiles) to which the user has access.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code>
|
||||
<pre>Lists profiles to which the user has access.
|
||||
<pre>Lists views (profiles) to which the user has access.
|
||||
|
||||
Args:
|
||||
accountId: string, Account ID for the profiles to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)
|
||||
webPropertyId: string, Web property ID for the profiles to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. (required)
|
||||
max_results: integer, The maximum number of profiles to include in this response.
|
||||
accountId: string, Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)
|
||||
webPropertyId: string, Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. (required)
|
||||
max_results: integer, The maximum number of views (profiles) to include in this response.
|
||||
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A profile collection lists Analytics profiles to which the user has access. Each resource in the collection corresponds to a single Analytics profile.
|
||||
{ # A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile).
|
||||
"username": "A String", # Email ID of the authenticated user
|
||||
"kind": "analytics#profiles", # Collection type.
|
||||
"items": [ # A list of profiles.
|
||||
{ # JSON template for an Analytics profile.
|
||||
"defaultPage": "A String", # Default page for this profile.
|
||||
"items": [ # A list of views (profiles).
|
||||
{ # JSON template for an Analytics view (profile).
|
||||
"defaultPage": "A String", # Default page for this view (profile).
|
||||
"kind": "analytics#profile", # Resource type for Analytics profile.
|
||||
"excludeQueryParameters": "A String", # The query parameters that are excluded from this profile.
|
||||
"name": "A String", # Name of this profile.
|
||||
"created": "A String", # Time this profile was created.
|
||||
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this profile belongs.
|
||||
"updated": "A String", # Time this profile was last modified.
|
||||
"siteSearchQueryParameters": "A String", # The site search query parameters for this profile.
|
||||
"websiteUrl": "A String", # Website URL for this profile.
|
||||
"currency": "A String", # The currency type associated with this profile.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this profile belongs.
|
||||
"childLink": { # Child link for this profile. Points to the list of goals for this profile.
|
||||
"href": "A String", # Link to the list of goals for this profile.
|
||||
"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
|
||||
"name": "A String", # Name of this view (profile).
|
||||
"created": "A String", # Time this view (profile) was created.
|
||||
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
|
||||
"updated": "A String", # Time this view (profile) was last modified.
|
||||
"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
|
||||
"websiteUrl": "A String", # Website URL for this view (profile).
|
||||
"currency": "A String", # The currency type associated with this view (profile).
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
|
||||
"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
|
||||
"href": "A String", # Link to the list of goals for this view (profile).
|
||||
"type": "analytics#goals", # Value is "analytics#goals".
|
||||
},
|
||||
"eCommerceTracking": True or False, # E-commerce tracking parameter for this profile.
|
||||
"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
|
||||
"timezone": "A String", # Time zone for which this profile has been configured.
|
||||
"siteSearchCategoryParameters": "A String", # Site search category parameters for this profile.
|
||||
"parentLink": { # Parent link for this profile. Points to the web property to which this profile belongs.
|
||||
"href": "A String", # Link to the web property to which this profile belongs.
|
||||
"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
|
||||
"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
|
||||
"href": "A String", # Link to the web property to which this view (profile) belongs.
|
||||
"type": "analytics#webproperty", # Value is "analytics#webproperty".
|
||||
},
|
||||
"type": "A String", # Profile type. Supported types: WEB or APP.
|
||||
"id": "A String", # Profile ID.
|
||||
"selfLink": "A String", # Link for this profile.
|
||||
"accountId": "A String", # Account ID to which this profile belongs.
|
||||
"type": "A String", # View (Profile) type. Supported types: WEB or APP.
|
||||
"id": "A String", # View (Profile) ID.
|
||||
"selfLink": "A String", # Link for this view (profile).
|
||||
"accountId": "A String", # Account ID to which this view (profile) belongs.
|
||||
},
|
||||
],
|
||||
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
|
||||
"previousLink": "A String", # Link to previous page for this profile collection.
|
||||
"previousLink": "A String", # Link to previous page for this view (profile) collection.
|
||||
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
|
||||
"nextLink": "A String", # Link to next page for this profile collection.
|
||||
"nextLink": "A String", # Link to next page for this view (profile) collection.
|
||||
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
@@ -95,16 +95,19 @@ Returns:
|
||||
"kind": "analytics#webproperties", # Collection type.
|
||||
"items": [ # A list of web properties.
|
||||
{ # JSON template for an Analytics web property.
|
||||
"websiteUrl": "A String", # Website url for this web property.
|
||||
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
|
||||
"name": "A String", # Name of this web property.
|
||||
"created": "A String", # Time this web property was created.
|
||||
"level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
|
||||
"updated": "A String", # Time this web property was last modified.
|
||||
"websiteUrl": "A String", # Website url for this web property.
|
||||
"profileCount": 42, # View (Profile) count for this web property.
|
||||
"internalWebPropertyId": "A String", # Internal ID for this web property.
|
||||
"childLink": { # Child link for this web property. Points to the list of profiles for this web property.
|
||||
"href": "A String", # Link to the list of profiles for this web property.
|
||||
"childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
|
||||
"href": "A String", # Link to the list of views (profiles) for this web property.
|
||||
"type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
|
||||
},
|
||||
"industryVertical": "A String", # The industry vertical/category selected for this web property.
|
||||
"parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
|
||||
"href": "A String", # Link to the account for this web property.
|
||||
"type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
|
||||
|
||||
87
docs/dyn/androidpublisher_v1_1.html
Normal file
87
docs/dyn/androidpublisher_v1_1.html
Normal file
@@ -0,0 +1,87 @@
|
||||
<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="androidpublisher_v1_1.html">Google Play Android Developer API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="androidpublisher_v1_1.inapppurchases.html">inapppurchases()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the inapppurchases Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="androidpublisher_v1_1.purchases.html">purchases()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the purchases Resource.</p>
|
||||
|
||||
</body></html>
|
||||
106
docs/dyn/androidpublisher_v1_1.inapppurchases.html
Normal file
106
docs/dyn/androidpublisher_v1_1.inapppurchases.html
Normal file
@@ -0,0 +1,106 @@
|
||||
<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="androidpublisher_v1_1.html">Google Play Android Developer API</a> . <a href="androidpublisher_v1_1.inapppurchases.html">inapppurchases</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(packageName, productId, token)</a></code></p>
|
||||
<p class="firstline">Checks the purchase and consumption status of an inapp item.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(packageName, productId, token)</code>
|
||||
<pre>Checks the purchase and consumption status of an inapp item.
|
||||
|
||||
Args:
|
||||
packageName: string, The package name of the application the inapp product was sold in (for example, 'com.some.thing'). (required)
|
||||
productId: string, The inapp product SKU (for example, 'com.some.thing.inapp1'). (required)
|
||||
token: string, The token provided to the user's device when the inapp product was purchased. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A Purchase resource indicates the status of a user's subscription purchase.
|
||||
"consumptionState": 42, # The consumption state of the inapp product. Possible values are:
|
||||
# - - Consumed
|
||||
# - - Yet to be consumed
|
||||
"developerPayload": "A String", # A developer-specified string that contains supplemental information about an order.
|
||||
"kind": "androidpublisher#inappPurchase", # This kind represents a inappPurchase object in the androidpublisher service.
|
||||
"purchaseTime": "A String", # The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).
|
||||
"purchaseState": 42, # The purchase state of the order. Possible values are:
|
||||
# - - Purchased
|
||||
# - - Cancelled
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
115
docs/dyn/androidpublisher_v1_1.purchases.html
Normal file
115
docs/dyn/androidpublisher_v1_1.purchases.html
Normal file
@@ -0,0 +1,115 @@
|
||||
<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="androidpublisher_v1_1.html">Google Play Android Developer API</a> . <a href="androidpublisher_v1_1.purchases.html">purchases</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#cancel">cancel(packageName, subscriptionId, token)</a></code></p>
|
||||
<p class="firstline">Cancels a user's subscription purchase. The subscription remains valid until its expiration time.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(packageName, subscriptionId, token)</a></code></p>
|
||||
<p class="firstline">Checks whether a user's subscription purchase is valid and returns its expiry time.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="cancel">cancel(packageName, subscriptionId, token)</code>
|
||||
<pre>Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
|
||||
|
||||
Args:
|
||||
packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
|
||||
subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
|
||||
token: string, The token provided to the user's device when the subscription was purchased. (required)
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(packageName, subscriptionId, token)</code>
|
||||
<pre>Checks whether a user's subscription purchase is valid and returns its expiry time.
|
||||
|
||||
Args:
|
||||
packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
|
||||
subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
|
||||
token: string, The token provided to the user's device when the subscription was purchased. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A Purchase resource indicates the status of a user's subscription purchase.
|
||||
"initiationTimestampMsec": "A String", # Time at which the subscription was granted, in milliseconds since Epoch.
|
||||
"kind": "androidpublisher#subscriptionPurchase", # This kind represents a subscriptionPurchase object in the androidpublisher service.
|
||||
"autoRenewing": True or False, # Whether the subscription will automatically be renewed when it reaches its current expiry time.
|
||||
"validUntilTimestampMsec": "A String", # Time at which the subscription will expire, in milliseconds since Epoch.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
82
docs/dyn/appstate_v1.html
Normal file
82
docs/dyn/appstate_v1.html
Normal file
@@ -0,0 +1,82 @@
|
||||
<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="appstate_v1.html">Google App State API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="appstate_v1.states.html">states()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the states Resource.</p>
|
||||
|
||||
</body></html>
|
||||
188
docs/dyn/appstate_v1.states.html
Normal file
188
docs/dyn/appstate_v1.states.html
Normal file
@@ -0,0 +1,188 @@
|
||||
<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="appstate_v1.html">Google App State API</a> . <a href="appstate_v1.states.html">states</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#clear">clear(stateKey, currentDataVersion=None)</a></code></p>
|
||||
<p class="firstline">Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(stateKey)</a></code></p>
|
||||
<p class="firstline">Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(stateKey)</a></code></p>
|
||||
<p class="firstline">Retrieves the data corresponding to the passed key.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(includeData=None)</a></code></p>
|
||||
<p class="firstline">Lists all the states keys, and optionally the state data.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(stateKey, body, currentStateVersion=None)</a></code></p>
|
||||
<p class="firstline">Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="clear">clear(stateKey, currentDataVersion=None)</code>
|
||||
<pre>Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.
|
||||
|
||||
Args:
|
||||
stateKey: integer, The key for the data to be retrieved. (required)
|
||||
currentDataVersion: string, The version of the data to be cleared. Version strings are returned by the server.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # This is a JSON template for an app state write result.
|
||||
"kind": "appstate#writeResult", # Uniquely identifies the type of this resource. Value is always the fixed string appstate#writeResult.
|
||||
"stateKey": 42, # The written key.
|
||||
"currentStateVersion": "A String", # The version of the data for this key on the server.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(stateKey)</code>
|
||||
<pre>Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption.
|
||||
|
||||
Args:
|
||||
stateKey: integer, The key for the data to be retrieved. (required)
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(stateKey)</code>
|
||||
<pre>Retrieves the data corresponding to the passed key.
|
||||
|
||||
Args:
|
||||
stateKey: integer, The key for the data to be retrieved. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # This is a JSON template for an app state resource.
|
||||
"stateKey": 42, # The key for the data.
|
||||
"kind": "appstate#getResponse", # Uniquely identifies the type of this resource. Value is always the fixed string appstate#getResponse.
|
||||
"data": "A String", # The requested data.
|
||||
"currentStateVersion": "A String", # The current app state version.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(includeData=None)</code>
|
||||
<pre>Lists all the states keys, and optionally the state data.
|
||||
|
||||
Args:
|
||||
includeData: boolean, Whether to include the full data in addition to the version number
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # This is a JSON template to convert a list-response for app state.
|
||||
"items": [ # The app state data.
|
||||
{ # This is a JSON template for an app state resource.
|
||||
"stateKey": 42, # The key for the data.
|
||||
"kind": "appstate#getResponse", # Uniquely identifies the type of this resource. Value is always the fixed string appstate#getResponse.
|
||||
"data": "A String", # The requested data.
|
||||
"currentStateVersion": "A String", # The current app state version.
|
||||
},
|
||||
],
|
||||
"kind": "appstate#listResponse", # Uniquely identifies the type of this resource. Value is always the fixed string appstate#listResponse.
|
||||
"maximumKeyCount": 42, # The maximum number of keys allowed for this user.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="update">update(stateKey, body, currentStateVersion=None)</code>
|
||||
<pre>Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB.
|
||||
|
||||
Args:
|
||||
stateKey: integer, The key for the data to be retrieved. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # This is a JSON template for a requests which update app state
|
||||
"kind": "appstate#updateRequest", # Uniquely identifies the type of this resource. Value is always the fixed string appstate#updateRequest.
|
||||
"data": "A String", # The new app state data that your application is trying to update with.
|
||||
}
|
||||
|
||||
currentStateVersion: string, The version of the app state your application is attempting to update. If this does not match the current version, this method will return a conflict error. If there is no data stored on the server for this key, the update will succeed irrespective of the value of this parameter.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # This is a JSON template for an app state write result.
|
||||
"kind": "appstate#writeResult", # Uniquely identifies the type of this resource. Value is always the fixed string appstate#writeResult.
|
||||
"stateKey": 42, # The written key.
|
||||
"currentStateVersion": "A String", # The version of the data for this key on the server.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -127,14 +127,14 @@ Returns:
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
@@ -165,14 +165,14 @@ Args:
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
@@ -197,14 +197,14 @@ Returns:
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
@@ -230,20 +230,20 @@ Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # A token to request the next page of results. Present only when there is more than one page of results.* See Paging Through Results in the developer's guide.
|
||||
"kind": "bigquery#datasetList", # The type of list.
|
||||
"datasets": [ # An array of one or more summarized dataset resources. Absent when there are no datasets in the specified project.
|
||||
"nextPageToken": "A String", # A token that can be used to request the next results page. This property is omitted on the final results page.
|
||||
"kind": "bigquery#datasetList", # The list type. This property always returns the value "bigquery#datasetList".
|
||||
"datasets": [ # An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.
|
||||
{
|
||||
"friendlyName": "A String", # A descriptive name for this dataset, if one exists.
|
||||
"kind": "bigquery#dataset", # The resource type.
|
||||
"id": "A String", # The fully-qualified unique name of this dataset in the format projectId:datasetId.
|
||||
"datasetReference": { # Reference identifying dataset.
|
||||
"friendlyName": "A String", # A descriptive name for the dataset, if one exists.
|
||||
"kind": "bigquery#dataset", # The resource type. This property always returns the value "bigquery#dataset".
|
||||
"id": "A String", # The fully-qualified, unique, opaque ID of the dataset.
|
||||
"datasetReference": { # The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
},
|
||||
],
|
||||
"etag": "A String", # A hash of this page of results. See Paging Through Results in the developer's guide.
|
||||
"etag": "A String", # A hash value of the results page. You can use this property to determine if the page has changed since the last request.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
@@ -280,14 +280,14 @@ Args:
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
@@ -312,14 +312,14 @@ Returns:
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
@@ -351,14 +351,14 @@ Args:
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
@@ -383,14 +383,14 @@ Returns:
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
|
||||
@@ -78,7 +78,7 @@ h1, h2, h3 {
|
||||
<code><a href="#get">get(projectId, jobId)</a></code></p>
|
||||
<p class="firstline">Retrieves the specified job by ID.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#getQueryResults">getQueryResults(projectId, jobId, timeoutMs=None, maxResults=None, startIndex=None)</a></code></p>
|
||||
<code><a href="#getQueryResults">getQueryResults(projectId, jobId, timeoutMs=None, pageToken=None, maxResults=None, startIndex=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the results of a query job.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(projectId, body=None, media_body=None)</a></code></p>
|
||||
@@ -109,16 +109,16 @@ Returns:
|
||||
"state": "A String", # [Output-only] Running state of the job.
|
||||
"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
|
||||
{
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
|
||||
"message": "A String", # A human-readable description of the error.
|
||||
"reason": "A String", # A short error code that summarizes the error.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
],
|
||||
"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
|
||||
"message": "A String", # A human-readable description of the error.
|
||||
"reason": "A String", # A short error code that summarizes the error.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
},
|
||||
@@ -131,6 +131,8 @@ Returns:
|
||||
"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
|
||||
},
|
||||
"query": { # [Output-only] Statistics for a query job.
|
||||
"completionRatio": 3.14, # [Output-Only] Approximate fraction of data processed for this query. This will be 1.0 unless min_completion_ratio for the query was set to something other than 1.0.
|
||||
"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
|
||||
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
|
||||
},
|
||||
"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
|
||||
@@ -154,6 +156,7 @@ Returns:
|
||||
},
|
||||
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
|
||||
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
|
||||
"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
|
||||
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
|
||||
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
|
||||
"A String",
|
||||
@@ -169,13 +172,14 @@ Returns:
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
"dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
|
||||
"link": { # [Pick one] Configures a link job.
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
@@ -189,6 +193,7 @@ Returns:
|
||||
],
|
||||
},
|
||||
"query": { # [Pick one] Configures a query job.
|
||||
"useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
@@ -201,8 +206,9 @@ Returns:
|
||||
"priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
|
||||
"allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
|
||||
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
|
||||
},
|
||||
"copy": { # [Pick one] Copies a table.
|
||||
@@ -230,9 +236,6 @@ Returns:
|
||||
},
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
|
||||
},
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.
|
||||
"a_key": "A String", # Key-value property pairs.
|
||||
},
|
||||
},
|
||||
"id": "A String", # [Output-only] Opaque ID field of the job
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
@@ -240,13 +243,14 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="getQueryResults">getQueryResults(projectId, jobId, timeoutMs=None, maxResults=None, startIndex=None)</code>
|
||||
<code class="details" id="getQueryResults">getQueryResults(projectId, jobId, timeoutMs=None, pageToken=None, maxResults=None, startIndex=None)</code>
|
||||
<pre>Retrieves the results of a query job.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the query job (required)
|
||||
jobId: string, Job ID of the query job (required)
|
||||
timeoutMs: integer, How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error
|
||||
pageToken: string, Page token, returned by a previous call, to request the next page of results
|
||||
maxResults: integer, Maximum number of results to read
|
||||
startIndex: string, Zero-based index of the starting row
|
||||
|
||||
@@ -258,7 +262,7 @@ Returns:
|
||||
"rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.
|
||||
{ # Represents a single row in the result set, consisting of one or more fields.
|
||||
"f": [
|
||||
{ # Represents a single cell in the result set.
|
||||
{ # Represents a single cell in the result set. Users of the java client can detect whether their value result is null by calling 'com.google.api.client.util.Data.isNull(cell.getV())'.
|
||||
"v": "",
|
||||
},
|
||||
],
|
||||
@@ -268,8 +272,10 @@ Returns:
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.
|
||||
"jobId": "A String", # [Required] ID of the job.
|
||||
},
|
||||
"pageToken": "A String", # A token used for paging results.
|
||||
"jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
|
||||
"totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.
|
||||
"cacheHit": True or False, # Whether the query result was fetched from the query cache.
|
||||
"etag": "A String", # A hash of this response.
|
||||
"schema": { # The schema of the results. Present only when the query completes successfully.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
@@ -277,7 +283,7 @@ Returns:
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
@@ -300,16 +306,16 @@ Args:
|
||||
"state": "A String", # [Output-only] Running state of the job.
|
||||
"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
|
||||
{
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
|
||||
"message": "A String", # A human-readable description of the error.
|
||||
"reason": "A String", # A short error code that summarizes the error.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
],
|
||||
"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
|
||||
"message": "A String", # A human-readable description of the error.
|
||||
"reason": "A String", # A short error code that summarizes the error.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
},
|
||||
@@ -322,6 +328,8 @@ Args:
|
||||
"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
|
||||
},
|
||||
"query": { # [Output-only] Statistics for a query job.
|
||||
"completionRatio": 3.14, # [Output-Only] Approximate fraction of data processed for this query. This will be 1.0 unless min_completion_ratio for the query was set to something other than 1.0.
|
||||
"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
|
||||
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
|
||||
},
|
||||
"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
|
||||
@@ -345,6 +353,7 @@ Args:
|
||||
},
|
||||
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
|
||||
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
|
||||
"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
|
||||
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
|
||||
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
|
||||
"A String",
|
||||
@@ -360,13 +369,14 @@ Args:
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
"dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
|
||||
"link": { # [Pick one] Configures a link job.
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
@@ -380,6 +390,7 @@ Args:
|
||||
],
|
||||
},
|
||||
"query": { # [Pick one] Configures a query job.
|
||||
"useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
@@ -392,8 +403,9 @@ Args:
|
||||
"priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
|
||||
"allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
|
||||
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
|
||||
},
|
||||
"copy": { # [Pick one] Copies a table.
|
||||
@@ -421,9 +433,6 @@ Args:
|
||||
},
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
|
||||
},
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.
|
||||
"a_key": "A String", # Key-value property pairs.
|
||||
},
|
||||
},
|
||||
"id": "A String", # [Output-only] Opaque ID field of the job
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
@@ -439,16 +448,16 @@ Returns:
|
||||
"state": "A String", # [Output-only] Running state of the job.
|
||||
"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
|
||||
{
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
|
||||
"message": "A String", # A human-readable description of the error.
|
||||
"reason": "A String", # A short error code that summarizes the error.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
],
|
||||
"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
|
||||
"message": "A String", # A human-readable description of the error.
|
||||
"reason": "A String", # A short error code that summarizes the error.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
},
|
||||
@@ -461,6 +470,8 @@ Returns:
|
||||
"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
|
||||
},
|
||||
"query": { # [Output-only] Statistics for a query job.
|
||||
"completionRatio": 3.14, # [Output-Only] Approximate fraction of data processed for this query. This will be 1.0 unless min_completion_ratio for the query was set to something other than 1.0.
|
||||
"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
|
||||
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
|
||||
},
|
||||
"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
|
||||
@@ -484,6 +495,7 @@ Returns:
|
||||
},
|
||||
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
|
||||
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
|
||||
"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
|
||||
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
|
||||
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
|
||||
"A String",
|
||||
@@ -499,13 +511,14 @@ Returns:
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
"dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
|
||||
"link": { # [Pick one] Configures a link job.
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
@@ -519,6 +532,7 @@ Returns:
|
||||
],
|
||||
},
|
||||
"query": { # [Pick one] Configures a query job.
|
||||
"useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
@@ -531,8 +545,9 @@ Returns:
|
||||
"priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
|
||||
"allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
|
||||
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
|
||||
},
|
||||
"copy": { # [Pick one] Copies a table.
|
||||
@@ -560,9 +575,6 @@ Returns:
|
||||
},
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
|
||||
},
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.
|
||||
"a_key": "A String", # Key-value property pairs.
|
||||
},
|
||||
},
|
||||
"id": "A String", # [Output-only] Opaque ID field of the job
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
@@ -602,16 +614,16 @@ Returns:
|
||||
"state": "A String", # [Output-only] Running state of the job.
|
||||
"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
|
||||
{
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
|
||||
"message": "A String", # A human-readable description of the error.
|
||||
"reason": "A String", # A short error code that summarizes the error.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
],
|
||||
"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
|
||||
"message": "A String", # A human-readable description of the error.
|
||||
"reason": "A String", # A short error code that summarizes the error.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
},
|
||||
@@ -624,6 +636,8 @@ Returns:
|
||||
"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
|
||||
},
|
||||
"query": { # [Output-only] Statistics for a query job.
|
||||
"completionRatio": 3.14, # [Output-Only] Approximate fraction of data processed for this query. This will be 1.0 unless min_completion_ratio for the query was set to something other than 1.0.
|
||||
"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
|
||||
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
|
||||
},
|
||||
"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
|
||||
@@ -647,6 +661,7 @@ Returns:
|
||||
},
|
||||
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
|
||||
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
|
||||
"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
|
||||
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
|
||||
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
|
||||
"A String",
|
||||
@@ -662,13 +677,14 @@ Returns:
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
"dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
|
||||
"link": { # [Pick one] Configures a link job.
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
@@ -682,6 +698,7 @@ Returns:
|
||||
],
|
||||
},
|
||||
"query": { # [Pick one] Configures a query job.
|
||||
"useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
@@ -694,8 +711,9 @@ Returns:
|
||||
"priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
|
||||
"allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
|
||||
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
|
||||
},
|
||||
"copy": { # [Pick one] Copies a table.
|
||||
@@ -723,15 +741,12 @@ Returns:
|
||||
},
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
|
||||
},
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.
|
||||
"a_key": "A String", # Key-value property pairs.
|
||||
},
|
||||
},
|
||||
"id": "A String", # Unique opaque ID of the job.
|
||||
"errorResult": { # A result object that will be present only if the job has failed.
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
|
||||
"message": "A String", # A human-readable description of the error.
|
||||
"reason": "A String", # A short error code that summarizes the error.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
},
|
||||
@@ -766,12 +781,14 @@ Args:
|
||||
"timeoutMs": 42, # [Optional] How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error.
|
||||
"kind": "bigquery#queryRequest", # The resource type of the request.
|
||||
"dryRun": True or False, # [Optional] If set, don't actually run the query. A valid query will return an empty response, while an invalid query will return the same error it would if it wasn't a dry run.
|
||||
"useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified.
|
||||
"defaultDataset": { # [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be fully-qualified in the format projectId:datasetId.tableid.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"maxResults": 42, # [Optional] The maximum number of results to return per page of results. If the response list exceeds the maximum response size for a single response, you will have to page through the results. Default is to return the maximum response size.
|
||||
"query": "A String", # [Required] A query string, following the BigQuery query syntax of the query to execute. Table names should be qualified by dataset name in the format projectId:datasetId.tableId unless you specify the defaultDataset value. If the table is in the same project as the job, you can omit the project ID. Example: SELECT f1 FROM myProjectId:myDatasetId.myTableId.
|
||||
"minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
|
||||
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
|
||||
}
|
||||
|
||||
@@ -784,7 +801,7 @@ Returns:
|
||||
"rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.
|
||||
{ # Represents a single row in the result set, consisting of one or more fields.
|
||||
"f": [
|
||||
{ # Represents a single cell in the result set.
|
||||
{ # Represents a single cell in the result set. Users of the java client can detect whether their value result is null by calling 'com.google.api.client.util.Data.isNull(cell.getV())'.
|
||||
"v": "",
|
||||
},
|
||||
],
|
||||
@@ -794,15 +811,18 @@ Returns:
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.
|
||||
"jobId": "A String", # [Required] ID of the job.
|
||||
},
|
||||
"pageToken": "A String", # A token used for paging results.
|
||||
"jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
|
||||
"totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.
|
||||
"totalBytesProcessed": "A String", # The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.
|
||||
"cacheHit": True or False, # Whether the query result was fetched from the query cache.
|
||||
"schema": { # The schema of the results. Present only when the query completes successfully.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
|
||||
@@ -101,6 +101,7 @@ Returns:
|
||||
{
|
||||
"friendlyName": "A String", # A descriptive name for this project.
|
||||
"kind": "bigquery#project", # The resource type.
|
||||
"numericId": "A String", # The numeric ID of this project.
|
||||
"id": "A String", # An opaque ID of this project.
|
||||
"projectReference": { # A unique reference to this project.
|
||||
"projectId": "A String", # [Required] ID of the project. Can be either the numeric ID or the assigned ID of the project.
|
||||
|
||||
@@ -100,7 +100,7 @@ Returns:
|
||||
"rows": [ # Rows of results.
|
||||
{ # Represents a single row in the result set, consisting of one or more fields.
|
||||
"f": [
|
||||
{ # Represents a single cell in the result set.
|
||||
{ # Represents a single cell in the result set. Users of the java client can detect whether their value result is null by calling 'com.google.api.client.util.Data.isNull(cell.getV())'.
|
||||
"v": "",
|
||||
},
|
||||
],
|
||||
|
||||
@@ -142,7 +142,7 @@ Returns:
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
@@ -184,7 +184,7 @@ Args:
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
@@ -219,7 +219,7 @@ Returns:
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
@@ -309,7 +309,7 @@ Args:
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
@@ -344,7 +344,7 @@ Returns:
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
@@ -387,7 +387,7 @@ Args:
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
@@ -422,7 +422,7 @@ Returns:
|
||||
"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates a nested schema).
|
||||
"type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
|
||||
"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
|
||||
"name": "A String", # [Required] The field name.
|
||||
},
|
||||
|
||||
192
docs/dyn/blogger_v3.blogUserInfos.html
Normal file
192
docs/dyn/blogger_v3.blogUserInfos.html
Normal file
@@ -0,0 +1,192 @@
|
||||
<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="blogger_v3.html">Blogger API</a> . <a href="blogger_v3.blogUserInfos.html">blogUserInfos</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(userId, blogId, maxPosts=None)</a></code></p>
|
||||
<p class="firstline">Gets one blog and user info pair by blogId and userId.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(userId, blogId, maxPosts=None)</code>
|
||||
<pre>Gets one blog and user info pair by blogId and userId.
|
||||
|
||||
Args:
|
||||
userId: string, ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)
|
||||
blogId: string, The ID of the blog to get. (required)
|
||||
maxPosts: integer, Maximum number of posts to pull back with the blog.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"blog": {
|
||||
"kind": "blogger#blog", # The kind of this entry. Always blogger#blog
|
||||
"description": "A String", # The description of this blog. This is displayed underneath the title.
|
||||
"locale": { # The locale this Blog is set to.
|
||||
"country": "A String", # The country this blog's locale is set to.
|
||||
"variant": "A String", # The language variant this blog is authored in.
|
||||
"language": "A String", # The language this blog is authored in.
|
||||
},
|
||||
"posts": { # The container of posts in this blog.
|
||||
"totalItems": 42, # The count of posts in this blog.
|
||||
"items": [ # The List of Posts for this Blog.
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the container for posts in this blog.
|
||||
},
|
||||
"customMetaData": "A String", # The JSON custom meta-data for the Blog
|
||||
"updated": "A String", # RFC 3339 date-time when this blog was last updated.
|
||||
"pages": { # The container of pages in this blog.
|
||||
"totalItems": 42, # The count of pages in this blog.
|
||||
"selfLink": "A String", # The URL of the container for pages in this blog.
|
||||
},
|
||||
"url": "A String", # The URL where this blog is published.
|
||||
"published": "A String", # RFC 3339 date-time when this blog was published.
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
"name": "A String", # The name of this blog. This is displayed as the title.
|
||||
},
|
||||
"kind": "blogger#blogUserInfo",
|
||||
"user": {
|
||||
"kind": "blogger#blogPerUserInfo",
|
||||
"userId": "A String",
|
||||
"blogId": "A String",
|
||||
"photosAlbumKey": "A String",
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -74,6 +74,11 @@ h1, h2, h3 {
|
||||
|
||||
<h1><a href="blogger_v3.html">Blogger API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="blogger_v3.blogUserInfos.html">blogUserInfos()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the blogUserInfos Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="blogger_v3.blogs.html">blogs()</a></code>
|
||||
</p>
|
||||
|
||||
@@ -269,7 +269,7 @@ Returns:
|
||||
<pre>Add a post.
|
||||
|
||||
Args:
|
||||
blogId: string, ID of the blog to fetch the post from. (required)
|
||||
blogId: string, ID of the blog to add the post to. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
|
||||
@@ -142,7 +142,24 @@ Returns:
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
|
||||
},
|
||||
"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"offers": [ # Offers available for this volume (sales and rentals).
|
||||
{
|
||||
"rentalDuration": { # The rental duration (for rental offers only).
|
||||
"count": 3.14,
|
||||
"unit": "A String",
|
||||
},
|
||||
"retailPrice": { # Offer retail (=discounted) price in Micros
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"listPrice": { # Offer list (=undiscounted) price in Micros.
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
|
||||
},
|
||||
],
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
|
||||
"onSaleDate": "A String", # The date on which this book is available for sale.
|
||||
"listPrice": { # Suggested retail price. (In LITE projection.)
|
||||
@@ -208,7 +225,25 @@ Returns:
|
||||
},
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
|
||||
"rentalPeriod": { # Period during this book is/was a valid rental.
|
||||
"startUtcSec": "A String",
|
||||
"endUtcSec": "A String",
|
||||
},
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
|
||||
"userUploadedVolumeInfo": {
|
||||
"processingState": "A String",
|
||||
},
|
||||
"rentalState": "A String", # Whether this book is an active or an expired rental.
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"review": { # This user's review of this volume, if one exists.
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
|
||||
"kind": "books#review", # Resource type for a review.
|
||||
@@ -227,17 +262,14 @@ Returns:
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
|
||||
},
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
|
||||
"copy": { # Copy/Paste accounting information.
|
||||
"limitType": "A String",
|
||||
"remainingCharacterCount": 42,
|
||||
"updated": "A String",
|
||||
"allowedCharacterCount": 42,
|
||||
},
|
||||
"isUploaded": True or False, # Whether or not this volume was user uploaded.
|
||||
},
|
||||
},
|
||||
],
|
||||
|
||||
144
docs/dyn/books_v1.cloudloading.html
Normal file
144
docs/dyn/books_v1.cloudloading.html
Normal file
@@ -0,0 +1,144 @@
|
||||
<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="books_v1.html">Books API</a> . <a href="books_v1.cloudloading.html">cloudloading</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#addBook">addBook(upload_client_token=None, name=None, drive_document_id=None, mime_type=None)</a></code></p>
|
||||
<p class="firstline"></p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#deleteBook">deleteBook(volumeId)</a></code></p>
|
||||
<p class="firstline">Remove the book and its contents</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#updateBook">updateBook(body)</a></code></p>
|
||||
<p class="firstline"></p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="addBook">addBook(upload_client_token=None, name=None, drive_document_id=None, mime_type=None)</code>
|
||||
<pre>
|
||||
|
||||
Args:
|
||||
upload_client_token: string, A parameter
|
||||
name: string, The document name. It can be set only if the drive_document_id is set.
|
||||
drive_document_id: string, A drive document id. The upload_client_token must not be set.
|
||||
mime_type: string, The document MIME type. It can be set only if the drive_document_id is set.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"title": "A String",
|
||||
"processingState": "A String",
|
||||
"volumeId": "A String",
|
||||
"author": "A String",
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="deleteBook">deleteBook(volumeId)</code>
|
||||
<pre>Remove the book and its contents
|
||||
|
||||
Args:
|
||||
volumeId: string, The id of the book to be removed. (required)
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="updateBook">updateBook(body)</code>
|
||||
<pre>
|
||||
|
||||
Args:
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"title": "A String",
|
||||
"processingState": "A String",
|
||||
"volumeId": "A String",
|
||||
"author": "A String",
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"title": "A String",
|
||||
"processingState": "A String",
|
||||
"volumeId": "A String",
|
||||
"author": "A String",
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -79,6 +79,11 @@ h1, h2, h3 {
|
||||
</p>
|
||||
<p class="firstline">Returns the bookshelves Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="books_v1.cloudloading.html">cloudloading()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the cloudloading Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="books_v1.layers.html">layers()</a></code>
|
||||
</p>
|
||||
|
||||
@@ -81,7 +81,7 @@ h1, h2, h3 {
|
||||
<code><a href="#requestAccess">requestAccess(source, volumeId, nonce, cpksver, locale=None)</a></code></p>
|
||||
<p class="firstline">Request concurrent and download access restrictions.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#syncVolumeLicenses">syncVolumeLicenses(source, nonce, cpksver, locale=None, showPreorders=None, volumeIds=None)</a></code></p>
|
||||
<code><a href="#syncVolumeLicenses">syncVolumeLicenses(source, nonce, cpksver, features=None, locale=None, showPreorders=None, volumeIds=None)</a></code></p>
|
||||
<p class="firstline">Request downloaded content access for specified volumes on the My eBooks shelf.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
@@ -165,13 +165,16 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="syncVolumeLicenses">syncVolumeLicenses(source, nonce, cpksver, locale=None, showPreorders=None, volumeIds=None)</code>
|
||||
<code class="details" id="syncVolumeLicenses">syncVolumeLicenses(source, nonce, cpksver, features=None, locale=None, showPreorders=None, volumeIds=None)</code>
|
||||
<pre>Request downloaded content access for specified volumes on the My eBooks shelf.
|
||||
|
||||
Args:
|
||||
source: string, String to identify the originator of this request. (required)
|
||||
nonce: string, The client nonce value. (required)
|
||||
cpksver: string, The device/version ID from which to release the restriction. (required)
|
||||
features: string, List of features supported by the client, i.e., 'RENTALS' (repeated)
|
||||
Allowed values
|
||||
RENTALS - Client supports rentals.
|
||||
locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
|
||||
showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.
|
||||
volumeIds: string, The volume(s) to request download restrictions for. (repeated)
|
||||
@@ -228,7 +231,24 @@ Returns:
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
|
||||
},
|
||||
"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"offers": [ # Offers available for this volume (sales and rentals).
|
||||
{
|
||||
"rentalDuration": { # The rental duration (for rental offers only).
|
||||
"count": 3.14,
|
||||
"unit": "A String",
|
||||
},
|
||||
"retailPrice": { # Offer retail (=discounted) price in Micros
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"listPrice": { # Offer list (=undiscounted) price in Micros.
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
|
||||
},
|
||||
],
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
|
||||
"onSaleDate": "A String", # The date on which this book is available for sale.
|
||||
"listPrice": { # Suggested retail price. (In LITE projection.)
|
||||
@@ -294,7 +314,25 @@ Returns:
|
||||
},
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
|
||||
"rentalPeriod": { # Period during this book is/was a valid rental.
|
||||
"startUtcSec": "A String",
|
||||
"endUtcSec": "A String",
|
||||
},
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
|
||||
"userUploadedVolumeInfo": {
|
||||
"processingState": "A String",
|
||||
},
|
||||
"rentalState": "A String", # Whether this book is an active or an expired rental.
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"review": { # This user's review of this volume, if one exists.
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
|
||||
"kind": "books#review", # Resource type for a review.
|
||||
@@ -313,17 +351,14 @@ Returns:
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
|
||||
},
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
|
||||
"copy": { # Copy/Paste accounting information.
|
||||
"limitType": "A String",
|
||||
"remainingCharacterCount": 42,
|
||||
"updated": "A String",
|
||||
"allowedCharacterCount": 42,
|
||||
},
|
||||
"isUploaded": True or False, # Whether or not this volume was user uploaded.
|
||||
},
|
||||
},
|
||||
],
|
||||
|
||||
@@ -81,7 +81,7 @@ h1, h2, h3 {
|
||||
<code><a href="#get">get(annotationId, source=None)</a></code></p>
|
||||
<p class="firstline">Gets an annotation by its ID.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(body, source=None)</a></code></p>
|
||||
<code><a href="#insert">insert(body, source=None, showOnlySummaryInResponse=None)</a></code></p>
|
||||
<p class="firstline">Inserts a new annotation.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(pageToken=None, updatedMax=None, layerId=None, volumeId=None, maxResults=None, showDeleted=None, pageIds=None, contentVersion=None, source=None, updatedMin=None)</a></code></p>
|
||||
@@ -89,6 +89,9 @@ h1, h2, h3 {
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#summary">summary(layerIds, volumeId)</a></code></p>
|
||||
<p class="firstline">Gets the summary of specified layers.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(annotationId, body, source=None)</a></code></p>
|
||||
<p class="firstline">Updates an existing annotation.</p>
|
||||
@@ -119,7 +122,7 @@ Returns:
|
||||
"updated": "A String", # Timestamp for the last time this annotation was modified.
|
||||
"created": "A String", # Timestamp for the created time of this annotation.
|
||||
"deleted": True or False, # Indicates that this annotation is deleted.
|
||||
"beforeSelectedText": "A String", # Anchor text before excerpt.
|
||||
"beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
|
||||
"currentVersionRanges": { # Selection ranges for the most recent content version.
|
||||
"contentVersion": "A String", # Content version applicable to ranges below.
|
||||
"gbTextRange": { # Range in GB text format for this annotation for version above.
|
||||
@@ -134,6 +137,12 @@ Returns:
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"imageCfiRange": { # Range in image CFI format for this annotation for version above.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"gbImageRange": { # Range in GB image format for this annotation for version above.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
@@ -141,7 +150,7 @@ Returns:
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
},
|
||||
"afterSelectedText": "A String", # Anchor text after excerpt.
|
||||
"afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
|
||||
"clientVersionRanges": { # Selection ranges sent from the client.
|
||||
"contentVersion": "A String", # Content version the client sent in.
|
||||
"gbTextRange": { # Range in GB text format for this annotation sent by client.
|
||||
@@ -156,6 +165,12 @@ Returns:
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"imageCfiRange": { # Range in image CFI format for this annotation sent by client.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"gbImageRange": { # Range in GB image format for this annotation sent by client.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
@@ -163,6 +178,11 @@ Returns:
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
},
|
||||
"layerSummary": {
|
||||
"limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
|
||||
"remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
|
||||
"allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
|
||||
},
|
||||
"volumeId": "A String", # The volume that this annotation belongs to.
|
||||
"pageIds": [ # Pages that this annotation spans.
|
||||
"A String",
|
||||
@@ -177,7 +197,7 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(body, source=None)</code>
|
||||
<code class="details" id="insert">insert(body, source=None, showOnlySummaryInResponse=None)</code>
|
||||
<pre>Inserts a new annotation.
|
||||
|
||||
Args:
|
||||
@@ -189,7 +209,7 @@ Args:
|
||||
"updated": "A String", # Timestamp for the last time this annotation was modified.
|
||||
"created": "A String", # Timestamp for the created time of this annotation.
|
||||
"deleted": True or False, # Indicates that this annotation is deleted.
|
||||
"beforeSelectedText": "A String", # Anchor text before excerpt.
|
||||
"beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
|
||||
"currentVersionRanges": { # Selection ranges for the most recent content version.
|
||||
"contentVersion": "A String", # Content version applicable to ranges below.
|
||||
"gbTextRange": { # Range in GB text format for this annotation for version above.
|
||||
@@ -204,6 +224,12 @@ Args:
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"imageCfiRange": { # Range in image CFI format for this annotation for version above.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"gbImageRange": { # Range in GB image format for this annotation for version above.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
@@ -211,7 +237,7 @@ Args:
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
},
|
||||
"afterSelectedText": "A String", # Anchor text after excerpt.
|
||||
"afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
|
||||
"clientVersionRanges": { # Selection ranges sent from the client.
|
||||
"contentVersion": "A String", # Content version the client sent in.
|
||||
"gbTextRange": { # Range in GB text format for this annotation sent by client.
|
||||
@@ -226,6 +252,12 @@ Args:
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"imageCfiRange": { # Range in image CFI format for this annotation sent by client.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"gbImageRange": { # Range in GB image format for this annotation sent by client.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
@@ -233,6 +265,11 @@ Args:
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
},
|
||||
"layerSummary": {
|
||||
"limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
|
||||
"remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
|
||||
"allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
|
||||
},
|
||||
"volumeId": "A String", # The volume that this annotation belongs to.
|
||||
"pageIds": [ # Pages that this annotation spans.
|
||||
"A String",
|
||||
@@ -246,6 +283,7 @@ Args:
|
||||
}
|
||||
|
||||
source: string, String to identify the originator of this request.
|
||||
showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
@@ -255,7 +293,7 @@ Returns:
|
||||
"updated": "A String", # Timestamp for the last time this annotation was modified.
|
||||
"created": "A String", # Timestamp for the created time of this annotation.
|
||||
"deleted": True or False, # Indicates that this annotation is deleted.
|
||||
"beforeSelectedText": "A String", # Anchor text before excerpt.
|
||||
"beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
|
||||
"currentVersionRanges": { # Selection ranges for the most recent content version.
|
||||
"contentVersion": "A String", # Content version applicable to ranges below.
|
||||
"gbTextRange": { # Range in GB text format for this annotation for version above.
|
||||
@@ -270,6 +308,12 @@ Returns:
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"imageCfiRange": { # Range in image CFI format for this annotation for version above.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"gbImageRange": { # Range in GB image format for this annotation for version above.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
@@ -277,7 +321,7 @@ Returns:
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
},
|
||||
"afterSelectedText": "A String", # Anchor text after excerpt.
|
||||
"afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
|
||||
"clientVersionRanges": { # Selection ranges sent from the client.
|
||||
"contentVersion": "A String", # Content version the client sent in.
|
||||
"gbTextRange": { # Range in GB text format for this annotation sent by client.
|
||||
@@ -292,6 +336,12 @@ Returns:
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"imageCfiRange": { # Range in image CFI format for this annotation sent by client.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"gbImageRange": { # Range in GB image format for this annotation sent by client.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
@@ -299,6 +349,11 @@ Returns:
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
},
|
||||
"layerSummary": {
|
||||
"limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
|
||||
"remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
|
||||
"allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
|
||||
},
|
||||
"volumeId": "A String", # The volume that this annotation belongs to.
|
||||
"pageIds": [ # Pages that this annotation spans.
|
||||
"A String",
|
||||
@@ -339,7 +394,7 @@ Returns:
|
||||
"updated": "A String", # Timestamp for the last time this annotation was modified.
|
||||
"created": "A String", # Timestamp for the created time of this annotation.
|
||||
"deleted": True or False, # Indicates that this annotation is deleted.
|
||||
"beforeSelectedText": "A String", # Anchor text before excerpt.
|
||||
"beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
|
||||
"currentVersionRanges": { # Selection ranges for the most recent content version.
|
||||
"contentVersion": "A String", # Content version applicable to ranges below.
|
||||
"gbTextRange": { # Range in GB text format for this annotation for version above.
|
||||
@@ -354,6 +409,12 @@ Returns:
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"imageCfiRange": { # Range in image CFI format for this annotation for version above.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"gbImageRange": { # Range in GB image format for this annotation for version above.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
@@ -361,7 +422,7 @@ Returns:
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
},
|
||||
"afterSelectedText": "A String", # Anchor text after excerpt.
|
||||
"afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
|
||||
"clientVersionRanges": { # Selection ranges sent from the client.
|
||||
"contentVersion": "A String", # Content version the client sent in.
|
||||
"gbTextRange": { # Range in GB text format for this annotation sent by client.
|
||||
@@ -376,6 +437,12 @@ Returns:
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"imageCfiRange": { # Range in image CFI format for this annotation sent by client.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"gbImageRange": { # Range in GB image format for this annotation sent by client.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
@@ -383,6 +450,11 @@ Returns:
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
},
|
||||
"layerSummary": {
|
||||
"limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
|
||||
"remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
|
||||
"allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
|
||||
},
|
||||
"volumeId": "A String", # The volume that this annotation belongs to.
|
||||
"pageIds": [ # Pages that this annotation spans.
|
||||
"A String",
|
||||
@@ -414,6 +486,31 @@ Returns:
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="summary">summary(layerIds, volumeId)</code>
|
||||
<pre>Gets the summary of specified layers.
|
||||
|
||||
Args:
|
||||
layerIds: string, Array of layer IDs to get the summary for. (required) (repeated)
|
||||
volumeId: string, Volume id to get the summary for. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"layers": [
|
||||
{
|
||||
"limitType": "A String",
|
||||
"remainingCharacterCount": 42,
|
||||
"updated": "A String",
|
||||
"layerId": "A String",
|
||||
"allowedCharacterCount": 42,
|
||||
},
|
||||
],
|
||||
"kind": "books#annotationsSummary",
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="update">update(annotationId, body, source=None)</code>
|
||||
<pre>Updates an existing annotation.
|
||||
@@ -428,7 +525,7 @@ Args:
|
||||
"updated": "A String", # Timestamp for the last time this annotation was modified.
|
||||
"created": "A String", # Timestamp for the created time of this annotation.
|
||||
"deleted": True or False, # Indicates that this annotation is deleted.
|
||||
"beforeSelectedText": "A String", # Anchor text before excerpt.
|
||||
"beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
|
||||
"currentVersionRanges": { # Selection ranges for the most recent content version.
|
||||
"contentVersion": "A String", # Content version applicable to ranges below.
|
||||
"gbTextRange": { # Range in GB text format for this annotation for version above.
|
||||
@@ -443,6 +540,12 @@ Args:
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"imageCfiRange": { # Range in image CFI format for this annotation for version above.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"gbImageRange": { # Range in GB image format for this annotation for version above.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
@@ -450,7 +553,7 @@ Args:
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
},
|
||||
"afterSelectedText": "A String", # Anchor text after excerpt.
|
||||
"afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
|
||||
"clientVersionRanges": { # Selection ranges sent from the client.
|
||||
"contentVersion": "A String", # Content version the client sent in.
|
||||
"gbTextRange": { # Range in GB text format for this annotation sent by client.
|
||||
@@ -465,6 +568,12 @@ Args:
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"imageCfiRange": { # Range in image CFI format for this annotation sent by client.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"gbImageRange": { # Range in GB image format for this annotation sent by client.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
@@ -472,6 +581,11 @@ Args:
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
},
|
||||
"layerSummary": {
|
||||
"limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
|
||||
"remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
|
||||
"allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
|
||||
},
|
||||
"volumeId": "A String", # The volume that this annotation belongs to.
|
||||
"pageIds": [ # Pages that this annotation spans.
|
||||
"A String",
|
||||
@@ -494,7 +608,7 @@ Returns:
|
||||
"updated": "A String", # Timestamp for the last time this annotation was modified.
|
||||
"created": "A String", # Timestamp for the created time of this annotation.
|
||||
"deleted": True or False, # Indicates that this annotation is deleted.
|
||||
"beforeSelectedText": "A String", # Anchor text before excerpt.
|
||||
"beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
|
||||
"currentVersionRanges": { # Selection ranges for the most recent content version.
|
||||
"contentVersion": "A String", # Content version applicable to ranges below.
|
||||
"gbTextRange": { # Range in GB text format for this annotation for version above.
|
||||
@@ -509,6 +623,12 @@ Returns:
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"imageCfiRange": { # Range in image CFI format for this annotation for version above.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"gbImageRange": { # Range in GB image format for this annotation for version above.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
@@ -516,7 +636,7 @@ Returns:
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
},
|
||||
"afterSelectedText": "A String", # Anchor text after excerpt.
|
||||
"afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
|
||||
"clientVersionRanges": { # Selection ranges sent from the client.
|
||||
"contentVersion": "A String", # Content version the client sent in.
|
||||
"gbTextRange": { # Range in GB text format for this annotation sent by client.
|
||||
@@ -531,6 +651,12 @@ Returns:
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"imageCfiRange": { # Range in image CFI format for this annotation sent by client.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
"startOffset": "A String", # The offset from the starting position.
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
"gbImageRange": { # Range in GB image format for this annotation sent by client.
|
||||
"startPosition": "A String", # The starting position for the range.
|
||||
"endPosition": "A String", # The ending position for the range.
|
||||
@@ -538,6 +664,11 @@ Returns:
|
||||
"endOffset": "A String", # The offset from the ending position.
|
||||
},
|
||||
},
|
||||
"layerSummary": {
|
||||
"limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
|
||||
"remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
|
||||
"allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
|
||||
},
|
||||
"volumeId": "A String", # The volume that this annotation belongs to.
|
||||
"pageIds": [ # Pages that this annotation spans.
|
||||
"A String",
|
||||
|
||||
@@ -147,7 +147,24 @@ Returns:
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
|
||||
},
|
||||
"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"offers": [ # Offers available for this volume (sales and rentals).
|
||||
{
|
||||
"rentalDuration": { # The rental duration (for rental offers only).
|
||||
"count": 3.14,
|
||||
"unit": "A String",
|
||||
},
|
||||
"retailPrice": { # Offer retail (=discounted) price in Micros
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"listPrice": { # Offer list (=undiscounted) price in Micros.
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
|
||||
},
|
||||
],
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
|
||||
"onSaleDate": "A String", # The date on which this book is available for sale.
|
||||
"listPrice": { # Suggested retail price. (In LITE projection.)
|
||||
@@ -213,7 +230,25 @@ Returns:
|
||||
},
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
|
||||
"rentalPeriod": { # Period during this book is/was a valid rental.
|
||||
"startUtcSec": "A String",
|
||||
"endUtcSec": "A String",
|
||||
},
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
|
||||
"userUploadedVolumeInfo": {
|
||||
"processingState": "A String",
|
||||
},
|
||||
"rentalState": "A String", # Whether this book is an active or an expired rental.
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"review": { # This user's review of this volume, if one exists.
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
|
||||
"kind": "books#review", # Resource type for a review.
|
||||
@@ -232,17 +267,14 @@ Returns:
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
|
||||
},
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
|
||||
"copy": { # Copy/Paste accounting information.
|
||||
"limitType": "A String",
|
||||
"remainingCharacterCount": 42,
|
||||
"updated": "A String",
|
||||
"allowedCharacterCount": 42,
|
||||
},
|
||||
"isUploaded": True or False, # Whether or not this volume was user uploaded.
|
||||
},
|
||||
},
|
||||
],
|
||||
|
||||
@@ -143,7 +143,24 @@ Returns:
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
|
||||
},
|
||||
"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"offers": [ # Offers available for this volume (sales and rentals).
|
||||
{
|
||||
"rentalDuration": { # The rental duration (for rental offers only).
|
||||
"count": 3.14,
|
||||
"unit": "A String",
|
||||
},
|
||||
"retailPrice": { # Offer retail (=discounted) price in Micros
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"listPrice": { # Offer list (=undiscounted) price in Micros.
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
|
||||
},
|
||||
],
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
|
||||
"onSaleDate": "A String", # The date on which this book is available for sale.
|
||||
"listPrice": { # Suggested retail price. (In LITE projection.)
|
||||
@@ -209,7 +226,25 @@ Returns:
|
||||
},
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
|
||||
"rentalPeriod": { # Period during this book is/was a valid rental.
|
||||
"startUtcSec": "A String",
|
||||
"endUtcSec": "A String",
|
||||
},
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
|
||||
"userUploadedVolumeInfo": {
|
||||
"processingState": "A String",
|
||||
},
|
||||
"rentalState": "A String", # Whether this book is an active or an expired rental.
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"review": { # This user's review of this volume, if one exists.
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
|
||||
"kind": "books#review", # Resource type for a review.
|
||||
@@ -228,17 +263,14 @@ Returns:
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
|
||||
},
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
|
||||
"copy": { # Copy/Paste accounting information.
|
||||
"limitType": "A String",
|
||||
"remainingCharacterCount": 42,
|
||||
"updated": "A String",
|
||||
"allowedCharacterCount": 42,
|
||||
},
|
||||
"isUploaded": True or False, # Whether or not this volume was user uploaded.
|
||||
},
|
||||
},
|
||||
],
|
||||
|
||||
@@ -79,11 +79,21 @@ h1, h2, h3 {
|
||||
</p>
|
||||
<p class="firstline">Returns the associated Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="books_v1.volumes.mybooks.html">mybooks()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the mybooks Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="books_v1.volumes.recommended.html">recommended()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the recommended Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="books_v1.volumes.useruploaded.html">useruploaded()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the useruploaded Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(volumeId, projection=None, source=None, country=None, partner=None)</a></code></p>
|
||||
<p class="firstline">Gets volume information for a single volume.</p>
|
||||
@@ -154,7 +164,24 @@ Returns:
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
|
||||
},
|
||||
"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"offers": [ # Offers available for this volume (sales and rentals).
|
||||
{
|
||||
"rentalDuration": { # The rental duration (for rental offers only).
|
||||
"count": 3.14,
|
||||
"unit": "A String",
|
||||
},
|
||||
"retailPrice": { # Offer retail (=discounted) price in Micros
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"listPrice": { # Offer list (=undiscounted) price in Micros.
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
|
||||
},
|
||||
],
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
|
||||
"onSaleDate": "A String", # The date on which this book is available for sale.
|
||||
"listPrice": { # Suggested retail price. (In LITE projection.)
|
||||
@@ -220,7 +247,25 @@ Returns:
|
||||
},
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
|
||||
"rentalPeriod": { # Period during this book is/was a valid rental.
|
||||
"startUtcSec": "A String",
|
||||
"endUtcSec": "A String",
|
||||
},
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
|
||||
"userUploadedVolumeInfo": {
|
||||
"processingState": "A String",
|
||||
},
|
||||
"rentalState": "A String", # Whether this book is an active or an expired rental.
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"review": { # This user's review of this volume, if one exists.
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
|
||||
"kind": "books#review", # Resource type for a review.
|
||||
@@ -239,17 +284,14 @@ Returns:
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
|
||||
},
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
|
||||
"copy": { # Copy/Paste accounting information.
|
||||
"limitType": "A String",
|
||||
"remainingCharacterCount": 42,
|
||||
"updated": "A String",
|
||||
"allowedCharacterCount": 42,
|
||||
},
|
||||
"isUploaded": True or False, # Whether or not this volume was user uploaded.
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
@@ -346,7 +388,24 @@ Returns:
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
|
||||
},
|
||||
"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"offers": [ # Offers available for this volume (sales and rentals).
|
||||
{
|
||||
"rentalDuration": { # The rental duration (for rental offers only).
|
||||
"count": 3.14,
|
||||
"unit": "A String",
|
||||
},
|
||||
"retailPrice": { # Offer retail (=discounted) price in Micros
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"listPrice": { # Offer list (=undiscounted) price in Micros.
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
|
||||
},
|
||||
],
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
|
||||
"onSaleDate": "A String", # The date on which this book is available for sale.
|
||||
"listPrice": { # Suggested retail price. (In LITE projection.)
|
||||
@@ -412,7 +471,25 @@ Returns:
|
||||
},
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
|
||||
"rentalPeriod": { # Period during this book is/was a valid rental.
|
||||
"startUtcSec": "A String",
|
||||
"endUtcSec": "A String",
|
||||
},
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
|
||||
"userUploadedVolumeInfo": {
|
||||
"processingState": "A String",
|
||||
},
|
||||
"rentalState": "A String", # Whether this book is an active or an expired rental.
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"review": { # This user's review of this volume, if one exists.
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
|
||||
"kind": "books#review", # Resource type for a review.
|
||||
@@ -431,17 +508,14 @@ Returns:
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
|
||||
},
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
|
||||
"copy": { # Copy/Paste accounting information.
|
||||
"limitType": "A String",
|
||||
"remainingCharacterCount": 42,
|
||||
"updated": "A String",
|
||||
"allowedCharacterCount": 42,
|
||||
},
|
||||
"isUploaded": True or False, # Whether or not this volume was user uploaded.
|
||||
},
|
||||
},
|
||||
],
|
||||
|
||||
292
docs/dyn/books_v1.volumes.mybooks.html
Normal file
292
docs/dyn/books_v1.volumes.mybooks.html
Normal file
@@ -0,0 +1,292 @@
|
||||
<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="books_v1.html">Books API</a> . <a href="books_v1.volumes.html">volumes</a> . <a href="books_v1.volumes.mybooks.html">mybooks</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(source=None, locale=None, acquireMethod=None, maxResults=None, startIndex=None, processingState=None)</a></code></p>
|
||||
<p class="firstline">Return a list of books in My Library.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(source=None, locale=None, acquireMethod=None, maxResults=None, startIndex=None, processingState=None)</code>
|
||||
<pre>Return a list of books in My Library.
|
||||
|
||||
Args:
|
||||
source: string, String to identify the originator of this request.
|
||||
locale: string, ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.
|
||||
acquireMethod: string, How the book was aquired (repeated)
|
||||
Allowed values
|
||||
PREORDERED - Preordered books (not yet available)
|
||||
PREVIOUSLY_RENTED - User-rented books past their expiration time
|
||||
PUBLIC_DOMAIN - Public domain books
|
||||
PURCHASED - Purchased books
|
||||
RENTED - User-rented books
|
||||
SAMPLE - Sample books
|
||||
UPLOADED - User uploaded books
|
||||
maxResults: integer, Maximum number of results to return.
|
||||
startIndex: integer, Index of the first result to return (starts at 0)
|
||||
processingState: string, The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod. (repeated)
|
||||
Allowed values
|
||||
COMPLETED_FAILED - The volume processing hase failed.
|
||||
COMPLETED_SUCCESS - The volume processing was completed.
|
||||
RUNNING - The volume processing is not completed.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"totalItems": 42, # Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.
|
||||
"items": [ # A list of volumes.
|
||||
{
|
||||
"kind": "books#volume", # Resource type for a volume. (In LITE projection.)
|
||||
"accessInfo": { # Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).
|
||||
"webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
|
||||
"publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
|
||||
"embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
|
||||
"downloadAccess": { # Information about a volume's download license access restrictions.
|
||||
"nonce": "A String", # Client nonce for verification. Download access and client-validation only.
|
||||
"kind": "books#downloadAccessRestriction", # Resource type.
|
||||
"justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
|
||||
"maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
|
||||
"downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
|
||||
"signature": "A String", # Response signature.
|
||||
"volumeId": "A String", # Identifies the volume for which this entry applies.
|
||||
"deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
|
||||
"source": "A String", # Client app identifier for verification. Download access and client-validation only.
|
||||
"restricted": True or False, # Whether this volume has any download access restrictions.
|
||||
"reasonCode": "A String", # Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS
|
||||
"message": "A String", # Error/warning message.
|
||||
},
|
||||
"country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
|
||||
"viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
|
||||
"textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
|
||||
"pdf": { # Information about pdf content. (In LITE projection.)
|
||||
"isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
|
||||
"downloadLink": "A String", # URL to download pdf. (In LITE projection.)
|
||||
"acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
|
||||
},
|
||||
"viewability": "A String", # The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES.
|
||||
"epub": { # Information about epub content. (In LITE projection.)
|
||||
"isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)
|
||||
"downloadLink": "A String", # URL to download epub. (In LITE projection.)
|
||||
"acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
|
||||
},
|
||||
"accessViewStatus": "A String", # Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)
|
||||
},
|
||||
"searchInfo": { # Search result information related to this volume.
|
||||
"textSnippet": "A String", # A text snippet containing the search query.
|
||||
},
|
||||
"saleInfo": { # Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries).
|
||||
"country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
|
||||
"retailPrice": { # The actual selling price of the book. This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)
|
||||
"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
|
||||
},
|
||||
"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
|
||||
"offers": [ # Offers available for this volume (sales and rentals).
|
||||
{
|
||||
"rentalDuration": { # The rental duration (for rental offers only).
|
||||
"count": 3.14,
|
||||
"unit": "A String",
|
||||
},
|
||||
"retailPrice": { # Offer retail (=discounted) price in Micros
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"listPrice": { # Offer list (=undiscounted) price in Micros.
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
|
||||
},
|
||||
],
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
|
||||
"onSaleDate": "A String", # The date on which this book is available for sale.
|
||||
"listPrice": { # Suggested retail price. (In LITE projection.)
|
||||
"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
|
||||
},
|
||||
},
|
||||
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)
|
||||
"volumeInfo": { # General volume information.
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
|
||||
"pageCount": 42, # Total number of pages.
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
|
||||
"large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
|
||||
"extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
|
||||
},
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.
|
||||
"dimensions": { # Physical dimensions of this volume.
|
||||
"width": "A String", # Width of this volume (in cm).
|
||||
"thickness": "A String", # Thickness of this volume (in cm).
|
||||
"height": "A String", # Height or length of this volume (in cm).
|
||||
},
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.
|
||||
{
|
||||
"identifier": "A String", # Industry specific volume identifier.
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
|
||||
},
|
||||
],
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
|
||||
"A String",
|
||||
],
|
||||
"title": "A String", # Volume title. (In LITE projection.)
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
|
||||
"A String",
|
||||
],
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
|
||||
},
|
||||
"recommendedInfo": { # Recommendation related information for this volume.
|
||||
"explanation": "A String", # A text explaining why this volume is recommended.
|
||||
},
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)
|
||||
"layerInfo": { # What layers exist in this volume and high level information about them.
|
||||
"layers": [ # A layer should appear here if and only if the layer exists for this book.
|
||||
{
|
||||
"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
|
||||
"layerId": "A String", # The layer id of this layer (e.g. "geo").
|
||||
},
|
||||
],
|
||||
},
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
|
||||
"rentalPeriod": { # Period during this book is/was a valid rental.
|
||||
"startUtcSec": "A String",
|
||||
"endUtcSec": "A String",
|
||||
},
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
|
||||
"userUploadedVolumeInfo": {
|
||||
"processingState": "A String",
|
||||
},
|
||||
"rentalState": "A String", # Whether this book is an active or an expired rental.
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"review": { # This user's review of this volume, if one exists.
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
|
||||
"kind": "books#review", # Resource type for a review.
|
||||
"author": { # Author of this review.
|
||||
"displayName": "A String", # Name of this person.
|
||||
},
|
||||
"title": "A String", # Title for this review.
|
||||
"volumeId": "A String", # Volume that this review is for.
|
||||
"content": "A String", # Review text.
|
||||
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
|
||||
"extraDescription": "A String", # Extra text about the source of the review.
|
||||
"url": "A String", # URL of the source of the review.
|
||||
"description": "A String", # Name of the source.
|
||||
},
|
||||
"date": "A String", # Date of this review.
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
|
||||
},
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
|
||||
"copy": { # Copy/Paste accounting information.
|
||||
"limitType": "A String",
|
||||
"remainingCharacterCount": 42,
|
||||
"updated": "A String",
|
||||
"allowedCharacterCount": 42,
|
||||
},
|
||||
"isUploaded": True or False, # Whether or not this volume was user uploaded.
|
||||
},
|
||||
},
|
||||
],
|
||||
"kind": "books#volumes", # Resource type.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -138,7 +138,24 @@ Returns:
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
|
||||
},
|
||||
"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"offers": [ # Offers available for this volume (sales and rentals).
|
||||
{
|
||||
"rentalDuration": { # The rental duration (for rental offers only).
|
||||
"count": 3.14,
|
||||
"unit": "A String",
|
||||
},
|
||||
"retailPrice": { # Offer retail (=discounted) price in Micros
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"listPrice": { # Offer list (=undiscounted) price in Micros.
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
|
||||
},
|
||||
],
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
|
||||
"onSaleDate": "A String", # The date on which this book is available for sale.
|
||||
"listPrice": { # Suggested retail price. (In LITE projection.)
|
||||
@@ -204,7 +221,25 @@ Returns:
|
||||
},
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
|
||||
"rentalPeriod": { # Period during this book is/was a valid rental.
|
||||
"startUtcSec": "A String",
|
||||
"endUtcSec": "A String",
|
||||
},
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
|
||||
"userUploadedVolumeInfo": {
|
||||
"processingState": "A String",
|
||||
},
|
||||
"rentalState": "A String", # Whether this book is an active or an expired rental.
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"review": { # This user's review of this volume, if one exists.
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
|
||||
"kind": "books#review", # Resource type for a review.
|
||||
@@ -223,17 +258,14 @@ Returns:
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
|
||||
},
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
|
||||
"copy": { # Copy/Paste accounting information.
|
||||
"limitType": "A String",
|
||||
"remainingCharacterCount": 42,
|
||||
"updated": "A String",
|
||||
"allowedCharacterCount": 42,
|
||||
},
|
||||
"isUploaded": True or False, # Whether or not this volume was user uploaded.
|
||||
},
|
||||
},
|
||||
],
|
||||
|
||||
284
docs/dyn/books_v1.volumes.useruploaded.html
Normal file
284
docs/dyn/books_v1.volumes.useruploaded.html
Normal file
@@ -0,0 +1,284 @@
|
||||
<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="books_v1.html">Books API</a> . <a href="books_v1.volumes.html">volumes</a> . <a href="books_v1.volumes.useruploaded.html">useruploaded</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(source=None, locale=None, volumeId=None, maxResults=None, startIndex=None, processingState=None)</a></code></p>
|
||||
<p class="firstline">Return a list of books uploaded by the current user.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(source=None, locale=None, volumeId=None, maxResults=None, startIndex=None, processingState=None)</code>
|
||||
<pre>Return a list of books uploaded by the current user.
|
||||
|
||||
Args:
|
||||
source: string, String to identify the originator of this request.
|
||||
locale: string, ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
|
||||
volumeId: string, The ids of the volumes to be returned. If not specified all that match the processingState are returned. (repeated)
|
||||
maxResults: integer, Maximum number of results to return.
|
||||
startIndex: integer, Index of the first result to return (starts at 0)
|
||||
processingState: string, The processing state of the user uploaded volumes to be returned. (repeated)
|
||||
Allowed values
|
||||
COMPLETED_FAILED - The volume processing hase failed.
|
||||
COMPLETED_SUCCESS - The volume processing was completed.
|
||||
RUNNING - The volume processing is not completed.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"totalItems": 42, # Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.
|
||||
"items": [ # A list of volumes.
|
||||
{
|
||||
"kind": "books#volume", # Resource type for a volume. (In LITE projection.)
|
||||
"accessInfo": { # Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).
|
||||
"webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
|
||||
"publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
|
||||
"embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
|
||||
"downloadAccess": { # Information about a volume's download license access restrictions.
|
||||
"nonce": "A String", # Client nonce for verification. Download access and client-validation only.
|
||||
"kind": "books#downloadAccessRestriction", # Resource type.
|
||||
"justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
|
||||
"maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
|
||||
"downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
|
||||
"signature": "A String", # Response signature.
|
||||
"volumeId": "A String", # Identifies the volume for which this entry applies.
|
||||
"deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
|
||||
"source": "A String", # Client app identifier for verification. Download access and client-validation only.
|
||||
"restricted": True or False, # Whether this volume has any download access restrictions.
|
||||
"reasonCode": "A String", # Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS
|
||||
"message": "A String", # Error/warning message.
|
||||
},
|
||||
"country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
|
||||
"viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
|
||||
"textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
|
||||
"pdf": { # Information about pdf content. (In LITE projection.)
|
||||
"isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
|
||||
"downloadLink": "A String", # URL to download pdf. (In LITE projection.)
|
||||
"acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
|
||||
},
|
||||
"viewability": "A String", # The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES.
|
||||
"epub": { # Information about epub content. (In LITE projection.)
|
||||
"isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)
|
||||
"downloadLink": "A String", # URL to download epub. (In LITE projection.)
|
||||
"acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
|
||||
},
|
||||
"accessViewStatus": "A String", # Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)
|
||||
},
|
||||
"searchInfo": { # Search result information related to this volume.
|
||||
"textSnippet": "A String", # A text snippet containing the search query.
|
||||
},
|
||||
"saleInfo": { # Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries).
|
||||
"country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
|
||||
"retailPrice": { # The actual selling price of the book. This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)
|
||||
"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
|
||||
},
|
||||
"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
|
||||
"offers": [ # Offers available for this volume (sales and rentals).
|
||||
{
|
||||
"rentalDuration": { # The rental duration (for rental offers only).
|
||||
"count": 3.14,
|
||||
"unit": "A String",
|
||||
},
|
||||
"retailPrice": { # Offer retail (=discounted) price in Micros
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"listPrice": { # Offer list (=undiscounted) price in Micros.
|
||||
"currencyCode": "A String",
|
||||
"amountInMicros": 3.14,
|
||||
},
|
||||
"finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
|
||||
},
|
||||
],
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
|
||||
"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
|
||||
"onSaleDate": "A String", # The date on which this book is available for sale.
|
||||
"listPrice": { # Suggested retail price. (In LITE projection.)
|
||||
"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
|
||||
},
|
||||
},
|
||||
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)
|
||||
"volumeInfo": { # General volume information.
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
|
||||
"pageCount": 42, # Total number of pages.
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
|
||||
"large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
|
||||
"extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
|
||||
},
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.
|
||||
"dimensions": { # Physical dimensions of this volume.
|
||||
"width": "A String", # Width of this volume (in cm).
|
||||
"thickness": "A String", # Thickness of this volume (in cm).
|
||||
"height": "A String", # Height or length of this volume (in cm).
|
||||
},
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.
|
||||
{
|
||||
"identifier": "A String", # Industry specific volume identifier.
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
|
||||
},
|
||||
],
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
|
||||
"A String",
|
||||
],
|
||||
"title": "A String", # Volume title. (In LITE projection.)
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
|
||||
"A String",
|
||||
],
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
|
||||
},
|
||||
"recommendedInfo": { # Recommendation related information for this volume.
|
||||
"explanation": "A String", # A text explaining why this volume is recommended.
|
||||
},
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)
|
||||
"layerInfo": { # What layers exist in this volume and high level information about them.
|
||||
"layers": [ # A layer should appear here if and only if the layer exists for this book.
|
||||
{
|
||||
"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
|
||||
"layerId": "A String", # The layer id of this layer (e.g. "geo").
|
||||
},
|
||||
],
|
||||
},
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
|
||||
"rentalPeriod": { # Period during this book is/was a valid rental.
|
||||
"startUtcSec": "A String",
|
||||
"endUtcSec": "A String",
|
||||
},
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
|
||||
"userUploadedVolumeInfo": {
|
||||
"processingState": "A String",
|
||||
},
|
||||
"rentalState": "A String", # Whether this book is an active or an expired rental.
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
|
||||
"volumeId": "A String", # Volume id associated with this reading position.
|
||||
"pdfPosition": "A String", # Position in a PDF file.
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.
|
||||
},
|
||||
"review": { # This user's review of this volume, if one exists.
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
|
||||
"kind": "books#review", # Resource type for a review.
|
||||
"author": { # Author of this review.
|
||||
"displayName": "A String", # Name of this person.
|
||||
},
|
||||
"title": "A String", # Title for this review.
|
||||
"volumeId": "A String", # Volume that this review is for.
|
||||
"content": "A String", # Review text.
|
||||
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
|
||||
"extraDescription": "A String", # Extra text about the source of the review.
|
||||
"url": "A String", # URL of the source of the review.
|
||||
"description": "A String", # Name of the source.
|
||||
},
|
||||
"date": "A String", # Date of this review.
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
|
||||
},
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
|
||||
"copy": { # Copy/Paste accounting information.
|
||||
"limitType": "A String",
|
||||
"remainingCharacterCount": 42,
|
||||
"updated": "A String",
|
||||
"allowedCharacterCount": 42,
|
||||
},
|
||||
"isUploaded": True or False, # Whether or not this volume was user uploaded.
|
||||
},
|
||||
},
|
||||
],
|
||||
"kind": "books#volumes", # Resource type.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
106
docs/dyn/calendar_v3.channels.html
Normal file
106
docs/dyn/calendar_v3.channels.html
Normal file
@@ -0,0 +1,106 @@
|
||||
<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="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.channels.html">channels</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#stop">stop(body)</a></code></p>
|
||||
<p class="firstline">A description of how to use this function</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="stop">stop(body)</code>
|
||||
<pre>A description of how to use this function
|
||||
|
||||
Args:
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"resourceUri": "A String", # The canonicalized ID of the watched resource.
|
||||
"kind": "api#channel", # A channel watching an API resource
|
||||
"resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
|
||||
"token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
|
||||
"params": { # Additional parameters controlling delivery channel behavior
|
||||
"a_key": "A String", # Declares a new parameter by name.
|
||||
},
|
||||
"expiration": "A String", # The expiration instant for this channel if it is defined.
|
||||
"address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
|
||||
"type": "A String", # The type of delivery mechanism used by this channel
|
||||
"id": "A String", # A UUID for the channel
|
||||
}
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -82,7 +82,7 @@ h1, h2, h3 {
|
||||
<p class="firstline">Returns an event.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#import_">import_(calendarId, body)</a></code></p>
|
||||
<p class="firstline">Imports an event.</p>
|
||||
<p class="firstline">Imports an event. This operation is used to add a private copy of an existing event to a calendar.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(calendarId, body, sendNotifications=None, maxAttendees=None)</a></code></p>
|
||||
<p class="firstline">Creates an event.</p>
|
||||
@@ -110,6 +110,9 @@ h1, h2, h3 {
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</a></code></p>
|
||||
<p class="firstline">Updates an event.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#watch">watch(calendarId, body, orderBy=None, showHiddenInvitations=None, timeMin=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, maxAttendees=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</a></code></p>
|
||||
<p class="firstline">Subscribe to changes in events collection</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(calendarId, eventId, sendNotifications=None)</code>
|
||||
@@ -170,15 +173,19 @@ Returns:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -252,13 +259,13 @@ Returns:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="import_">import_(calendarId, body)</code>
|
||||
<pre>Imports an event.
|
||||
<pre>Imports an event. This operation is used to add a private copy of an existing event to a calendar.
|
||||
|
||||
Args:
|
||||
calendarId: string, Calendar identifier. (required)
|
||||
@@ -299,15 +306,19 @@ Args:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -381,7 +392,7 @@ Args:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
}
|
||||
|
||||
|
||||
@@ -422,15 +433,19 @@ Returns:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -504,7 +519,7 @@ Returns:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
@@ -551,15 +566,19 @@ Args:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -633,7 +652,7 @@ Args:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
}
|
||||
|
||||
sendNotifications: boolean, Whether to send notifications about the creation of the new event. Optional. The default is False.
|
||||
@@ -676,15 +695,19 @@ Returns:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -758,7 +781,7 @@ Returns:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
@@ -830,15 +853,19 @@ Returns:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -912,7 +939,7 @@ Returns:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
},
|
||||
],
|
||||
"updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
|
||||
@@ -958,7 +985,7 @@ Args:
|
||||
updatedMin: string, Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
|
||||
singleEvents: boolean, Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
|
||||
alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
|
||||
showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if 'showDeleted' and 'singleEvents' are both False. If 'showDeleted' and 'singleEvents' are both True only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
|
||||
showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if 'showDeleted' and 'singleEvents' are both False. If 'showDeleted' and 'singleEvents' are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
|
||||
maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
|
||||
iCalUID: string, Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.
|
||||
maxResults: integer, Maximum number of events returned on one result page. Optional.
|
||||
@@ -1017,15 +1044,19 @@ Returns:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -1099,7 +1130,7 @@ Returns:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
},
|
||||
],
|
||||
"updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
|
||||
@@ -1176,15 +1207,19 @@ Returns:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -1258,7 +1293,7 @@ Returns:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
@@ -1306,15 +1341,19 @@ Args:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -1388,7 +1427,7 @@ Args:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
}
|
||||
|
||||
sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
|
||||
@@ -1432,15 +1471,19 @@ Returns:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -1514,7 +1557,7 @@ Returns:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
@@ -1564,15 +1607,19 @@ Returns:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -1646,7 +1693,7 @@ Returns:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
@@ -1694,15 +1741,19 @@ Args:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -1776,7 +1827,7 @@ Args:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
}
|
||||
|
||||
sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
|
||||
@@ -1820,15 +1871,19 @@ Returns:
|
||||
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
|
||||
},
|
||||
],
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
|
||||
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
|
||||
"timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
|
||||
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
|
||||
},
|
||||
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
|
||||
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
|
||||
"A String",
|
||||
],
|
||||
"source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
|
||||
"url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
|
||||
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
|
||||
},
|
||||
"etag": "A String", # ETag of the resource.
|
||||
"location": "A String", # Geographic location of the event as free-form text. Optional.
|
||||
"recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
|
||||
@@ -1902,7 +1957,66 @@ Returns:
|
||||
"transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||
# - "opaque" - The event blocks time on the calendar. This is the default value.
|
||||
# - "transparent" - The event does not block time on the calendar.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="watch">watch(calendarId, body, orderBy=None, showHiddenInvitations=None, timeMin=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, maxAttendees=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</code>
|
||||
<pre>Subscribe to changes in events collection
|
||||
|
||||
Args:
|
||||
calendarId: string, Calendar identifier. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"resourceUri": "A String", # The canonicalized ID of the watched resource.
|
||||
"kind": "api#channel", # A channel watching an API resource
|
||||
"resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
|
||||
"token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
|
||||
"params": { # Additional parameters controlling delivery channel behavior
|
||||
"a_key": "A String", # Declares a new parameter by name.
|
||||
},
|
||||
"expiration": "A String", # The expiration instant for this channel if it is defined.
|
||||
"address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
|
||||
"type": "A String", # The type of delivery mechanism used by this channel
|
||||
"id": "A String", # A UUID for the channel
|
||||
}
|
||||
|
||||
orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.
|
||||
Allowed values
|
||||
startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter "singleEvents" is True)
|
||||
updated - Order by last modification time (ascending).
|
||||
showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.
|
||||
timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
|
||||
pageToken: string, Token specifying which result page to return. Optional.
|
||||
updatedMin: string, Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
|
||||
singleEvents: boolean, Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
|
||||
alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
|
||||
showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if 'showDeleted' and 'singleEvents' are both False. If 'showDeleted' and 'singleEvents' are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
|
||||
maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
|
||||
iCalUID: string, Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.
|
||||
maxResults: integer, Maximum number of events returned on one result page. Optional.
|
||||
timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
|
||||
q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
|
||||
timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"resourceUri": "A String", # The canonicalized ID of the watched resource.
|
||||
"kind": "api#channel", # A channel watching an API resource
|
||||
"resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
|
||||
"token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
|
||||
"params": { # Additional parameters controlling delivery channel behavior
|
||||
"a_key": "A String", # Declares a new parameter by name.
|
||||
},
|
||||
"expiration": "A String", # The expiration instant for this channel if it is defined.
|
||||
"address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
|
||||
"type": "A String", # The type of delivery mechanism used by this channel
|
||||
"id": "A String", # A UUID for the channel
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -89,6 +89,11 @@ h1, h2, h3 {
|
||||
</p>
|
||||
<p class="firstline">Returns the calendars Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="calendar_v3.channels.html">channels()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the channels Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="calendar_v3.colors.html">colors()</a></code>
|
||||
</p>
|
||||
|
||||
@@ -248,7 +248,7 @@ Returns:
|
||||
"numberVotingFor": "A String", # The number of candidates that a voter may vote for in this contest.
|
||||
"office": "A String", # The name of the office for this contest.
|
||||
"district": { # Describes the geographic scope of a contest. # Information about the electoral district that this contest is in.
|
||||
"scope": "A String", # The geographic scope of this district. If unspecified the district's geography is not known. One of: statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, special
|
||||
"scope": "A String", # The geographic scope of this district. If unspecified the district's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special
|
||||
"id": "A String", # An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id "34" and a scope of stateUpper.
|
||||
"name": "A String", # The name of the district.
|
||||
},
|
||||
@@ -281,9 +281,9 @@ Returns:
|
||||
},
|
||||
],
|
||||
"numberElected": "A String", # The number of candidates that will be elected to office in this contest.
|
||||
"referendumUrl": "A String", # A link the referendum. This field is only populated for contests of type 'Referendum'.
|
||||
"referendumUrl": "A String", # A link to the referendum. This field is only populated for contests of type 'Referendum'.
|
||||
"electorateSpecifications": "A String", # A description of any additional eligibility requirements for voting in this contest.
|
||||
"referendumTitle": "A String", # The title of the referendum. (e.g. 'Proposition 42') This field is only populated for contests of type 'Referendum'.
|
||||
"referendumTitle": "A String", # The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.
|
||||
"id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
|
||||
"special": "A String", # "Yes" or "No" depending on whether this a contest being held outside the normal election cycle.
|
||||
},
|
||||
|
||||
367
docs/dyn/compute_v1beta15.addresses.html
Normal file
367
docs/dyn/compute_v1beta15.addresses.html
Normal file
@@ -0,0 +1,367 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.addresses.html">addresses</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of addresses grouped by scope.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(project, region, address)</a></code></p>
|
||||
<p class="firstline">Deletes the specified address resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, region, address)</a></code></p>
|
||||
<p class="firstline">Returns the specified address resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(project, region, body)</a></code></p>
|
||||
<p class="firstline">Creates an address resource in the specified project using the data included in the request.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of address resources contained within the specified region.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of addresses grouped by scope.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": { # A map of scoped address lists.
|
||||
"a_key": { # Name of the scope containing this set of addresses.
|
||||
"warning": { # Informational warning which replaces the list of addresses when the list is empty.
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
"addresses": [ # List of addresses contained in this scope.
|
||||
{ # A reserved address resource.
|
||||
"status": "A String", # The status of the address (output only).
|
||||
"kind": "compute#address", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"region": "A String", # URL of the region where the address resides (output only).
|
||||
"user": "A String", # URL of the resource currently using this address (output only).
|
||||
"address": "A String", # The IP address represented by this resource.
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
"kind": "compute#addressAggregatedList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</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="delete">delete(project, region, address)</code>
|
||||
<pre>Deletes the specified address resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
region: string, Name of the region scoping this request. (required)
|
||||
address: string, Name of the address resource to delete. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, region, address)</code>
|
||||
<pre>Returns the specified address resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
region: string, Name of the region scoping this request. (required)
|
||||
address: string, Name of the address resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A reserved address resource.
|
||||
"status": "A String", # The status of the address (output only).
|
||||
"kind": "compute#address", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"region": "A String", # URL of the region where the address resides (output only).
|
||||
"user": "A String", # URL of the resource currently using this address (output only).
|
||||
"address": "A String", # The IP address represented by this resource.
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(project, region, body)</code>
|
||||
<pre>Creates an address resource in the specified project using the data included in the request.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
region: string, Name of the region scoping this request. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A reserved address resource.
|
||||
"status": "A String", # The status of the address (output only).
|
||||
"kind": "compute#address", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"region": "A String", # URL of the region where the address resides (output only).
|
||||
"user": "A String", # URL of the resource currently using this address (output only).
|
||||
"address": "A String", # The IP address represented by this resource.
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of address resources contained within the specified region.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
region: string, Name of the region scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of address resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The address resources.
|
||||
{ # A reserved address resource.
|
||||
"status": "A String", # The status of the address (output only).
|
||||
"kind": "compute#address", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"region": "A String", # URL of the region where the address resides (output only).
|
||||
"user": "A String", # URL of the resource currently using this address (output only).
|
||||
"address": "A String", # The IP address represented by this resource.
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
},
|
||||
],
|
||||
"kind": "compute#addressList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
452
docs/dyn/compute_v1beta15.disks.html
Normal file
452
docs/dyn/compute_v1beta15.disks.html
Normal file
@@ -0,0 +1,452 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.disks.html">disks</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of disks grouped by scope.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#createSnapshot">createSnapshot(project, zone, disk, body)</a></code></p>
|
||||
<p class="firstline">A description of how to use this function</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(project, zone, disk)</a></code></p>
|
||||
<p class="firstline">Deletes the specified persistent disk resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, zone, disk)</a></code></p>
|
||||
<p class="firstline">Returns the specified persistent disk resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(project, zone, body, sourceImage=None)</a></code></p>
|
||||
<p class="firstline">Creates a persistent disk resource in the specified project using the data included in the request.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of persistent disk resources contained within the specified zone.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of disks grouped by scope.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": { # A map of scoped disk lists.
|
||||
"a_key": { # Name of the scope containing this set of disks.
|
||||
"disks": [ # List of disks contained in this scope.
|
||||
{ # A persistent disk resource.
|
||||
"status": "A String", # The status of disk creation (output only).
|
||||
"sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
|
||||
"kind": "compute#disk", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
|
||||
"zone": "A String", # URL of the zone where the disk resides (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"options": "A String", # Internal use only.
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
},
|
||||
],
|
||||
"warning": { # Informational warning which replaces the list of disks when the list is empty.
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
"kind": "compute#diskAggregatedList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</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="createSnapshot">createSnapshot(project, zone, disk, body)</code>
|
||||
<pre>A description of how to use this function
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
zone: string, Name of the zone scoping this request. (required)
|
||||
disk: string, Name of the persistent disk resource to delete. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A persistent disk snapshot resource.
|
||||
"status": "A String", # The status of the persistent disk snapshot (output only).
|
||||
"kind": "compute#snapshot", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created (output only).
|
||||
"sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
|
||||
"diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(project, zone, disk)</code>
|
||||
<pre>Deletes the specified persistent disk resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
zone: string, Name of the zone scoping this request. (required)
|
||||
disk: string, Name of the persistent disk resource to delete. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, zone, disk)</code>
|
||||
<pre>Returns the specified persistent disk resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
zone: string, Name of the zone scoping this request. (required)
|
||||
disk: string, Name of the persistent disk resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A persistent disk resource.
|
||||
"status": "A String", # The status of disk creation (output only).
|
||||
"sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
|
||||
"kind": "compute#disk", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
|
||||
"zone": "A String", # URL of the zone where the disk resides (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"options": "A String", # Internal use only.
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(project, zone, body, sourceImage=None)</code>
|
||||
<pre>Creates a persistent disk resource in the specified project using the data included in the request.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
zone: string, Name of the zone scoping this request. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A persistent disk resource.
|
||||
"status": "A String", # The status of disk creation (output only).
|
||||
"sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
|
||||
"kind": "compute#disk", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
|
||||
"zone": "A String", # URL of the zone where the disk resides (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"options": "A String", # Internal use only.
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}
|
||||
|
||||
sourceImage: string, Optional. Source image to restore onto a disk.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of persistent disk resources contained within the specified zone.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
zone: string, Name of the zone scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of persistent disk resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The persistent disk resources.
|
||||
{ # A persistent disk resource.
|
||||
"status": "A String", # The status of disk creation (output only).
|
||||
"sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
|
||||
"kind": "compute#disk", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
|
||||
"zone": "A String", # URL of the zone where the disk resides (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"options": "A String", # Internal use only.
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
},
|
||||
],
|
||||
"kind": "compute#diskList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
524
docs/dyn/compute_v1beta15.firewalls.html
Normal file
524
docs/dyn/compute_v1beta15.firewalls.html
Normal file
@@ -0,0 +1,524 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.firewalls.html">firewalls</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(project, firewall)</a></code></p>
|
||||
<p class="firstline">Deletes the specified firewall resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, firewall)</a></code></p>
|
||||
<p class="firstline">Returns the specified firewall resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(project, body)</a></code></p>
|
||||
<p class="firstline">Creates a firewall resource in the specified project using the data included in the request.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of firewall resources available to the specified project.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#patch">patch(project, firewall, body)</a></code></p>
|
||||
<p class="firstline">Updates the specified firewall resource with the data included in the request. This method supports patch semantics.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(project, firewall, body)</a></code></p>
|
||||
<p class="firstline">Updates the specified firewall resource with the data included in the request.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(project, firewall)</code>
|
||||
<pre>Deletes the specified firewall resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
firewall: string, Name of the firewall resource to delete. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, firewall)</code>
|
||||
<pre>Returns the specified firewall resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
firewall: string, Name of the firewall resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A firewall resource.
|
||||
"kind": "compute#firewall", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
|
||||
"A String",
|
||||
],
|
||||
"sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
|
||||
"A String",
|
||||
],
|
||||
"network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
|
||||
"targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
|
||||
"A String",
|
||||
],
|
||||
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
|
||||
{
|
||||
"IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
|
||||
"ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
|
||||
#
|
||||
# Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(project, body)</code>
|
||||
<pre>Creates a firewall resource in the specified project using the data included in the request.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A firewall resource.
|
||||
"kind": "compute#firewall", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
|
||||
"A String",
|
||||
],
|
||||
"sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
|
||||
"A String",
|
||||
],
|
||||
"network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
|
||||
"targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
|
||||
"A String",
|
||||
],
|
||||
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
|
||||
{
|
||||
"IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
|
||||
"ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
|
||||
#
|
||||
# Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of firewall resources available to the specified project.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of firewall resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The firewall resources.
|
||||
{ # A firewall resource.
|
||||
"kind": "compute#firewall", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
|
||||
"A String",
|
||||
],
|
||||
"sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
|
||||
"A String",
|
||||
],
|
||||
"network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
|
||||
"targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
|
||||
"A String",
|
||||
],
|
||||
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
|
||||
{
|
||||
"IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
|
||||
"ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
|
||||
#
|
||||
# Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
},
|
||||
],
|
||||
"kind": "compute#firewallList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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="patch">patch(project, firewall, body)</code>
|
||||
<pre>Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
firewall: string, Name of the firewall resource to update. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A firewall resource.
|
||||
"kind": "compute#firewall", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
|
||||
"A String",
|
||||
],
|
||||
"sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
|
||||
"A String",
|
||||
],
|
||||
"network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
|
||||
"targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
|
||||
"A String",
|
||||
],
|
||||
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
|
||||
{
|
||||
"IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
|
||||
"ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
|
||||
#
|
||||
# Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="update">update(project, firewall, body)</code>
|
||||
<pre>Updates the specified firewall resource with the data included in the request.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
firewall: string, Name of the firewall resource to update. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A firewall resource.
|
||||
"kind": "compute#firewall", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
|
||||
"A String",
|
||||
],
|
||||
"sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
|
||||
"A String",
|
||||
],
|
||||
"network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
|
||||
"targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
|
||||
"A String",
|
||||
],
|
||||
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
|
||||
{
|
||||
"IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
|
||||
"ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
|
||||
#
|
||||
# Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
336
docs/dyn/compute_v1beta15.globalOperations.html
Normal file
336
docs/dyn/compute_v1beta15.globalOperations.html
Normal file
@@ -0,0 +1,336 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.globalOperations.html">globalOperations</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of all operations grouped by scope.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(project, operation)</a></code></p>
|
||||
<p class="firstline">Deletes the specified operation resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, operation)</a></code></p>
|
||||
<p class="firstline">Retrieves the specified operation resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of operation resources contained within the specified project.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of all operations grouped by scope.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": { # A map of scoped operation lists.
|
||||
"a_key": { # Name of the scope containing this set of operations.
|
||||
"operations": [ # List of operations contained in this scope.
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
},
|
||||
],
|
||||
"warning": { # Informational warning which replaces the list of operations when the list is empty.
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
"kind": "compute#operationAggregatedList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</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="delete">delete(project, operation)</code>
|
||||
<pre>Deletes the specified operation resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
operation: string, Name of the operation resource to delete. (required)
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, operation)</code>
|
||||
<pre>Retrieves the specified operation resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
operation: string, Name of the operation resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of operation resources contained within the specified project.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of operation resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The operation resources.
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
},
|
||||
],
|
||||
"kind": "compute#operationList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
162
docs/dyn/compute_v1beta15.html
Normal file
162
docs/dyn/compute_v1beta15.html
Normal file
@@ -0,0 +1,162 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.addresses.html">addresses()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the addresses Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.disks.html">disks()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the disks Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.firewalls.html">firewalls()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the firewalls Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.globalOperations.html">globalOperations()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the globalOperations Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.httpHealthChecks.html">httpHealthChecks()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the httpHealthChecks Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.images.html">images()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the images Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.instances.html">instances()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the instances Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.kernels.html">kernels()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the kernels Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.machineTypes.html">machineTypes()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the machineTypes Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.networks.html">networks()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the networks Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.projects.html">projects()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the projects Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.regionOperations.html">regionOperations()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the regionOperations Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.regions.html">regions()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the regions Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.routes.html">routes()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the routes Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.snapshots.html">snapshots()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the snapshots Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.zoneOperations.html">zoneOperations()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the zoneOperations Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="compute_v1beta15.zones.html">zones()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the zones Resource.</p>
|
||||
|
||||
</body></html>
|
||||
156
docs/dyn/compute_v1beta15.httpHealthChecks.html
Normal file
156
docs/dyn/compute_v1beta15.httpHealthChecks.html
Normal file
@@ -0,0 +1,156 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.httpHealthChecks.html">httpHealthChecks</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#patch">patch(project, httpHealthCheck, body)</a></code></p>
|
||||
<p class="firstline">Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="patch">patch(project, httpHealthCheck, body)</code>
|
||||
<pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP.
|
||||
"kind": "compute#httpHealthCheck", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds.
|
||||
"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
|
||||
"port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
|
||||
"healthyThreshold": 42, # A so-far unhealthy VM will be marked healthy after this many consecutive successes. The default value is 2.
|
||||
"host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
|
||||
"requestPath": "A String", # The request path of the HTTP health check request. The default value is "/".
|
||||
"unhealthyThreshold": 42, # A so-far healthy VM will be marked unhealthy after this many consecutive failures. The default value is 2.
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
397
docs/dyn/compute_v1beta15.images.html
Normal file
397
docs/dyn/compute_v1beta15.images.html
Normal file
@@ -0,0 +1,397 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.images.html">images</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(project, image)</a></code></p>
|
||||
<p class="firstline">Deletes the specified image resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#deprecate">deprecate(project, image, body)</a></code></p>
|
||||
<p class="firstline">Sets the deprecation status of an image. If no message body is given, clears the deprecation status instead.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, image)</a></code></p>
|
||||
<p class="firstline">Returns the specified image resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(project, body)</a></code></p>
|
||||
<p class="firstline">Creates an image resource in the specified project using the data included in the request.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of image resources available to the specified project.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(project, image)</code>
|
||||
<pre>Deletes the specified image resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
image: string, Name of the image resource to delete. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="deprecate">deprecate(project, image, body)</code>
|
||||
<pre>Sets the deprecation status of an image. If no message body is given, clears the deprecation status instead.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
image: string, Image name. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # Deprecation status for a public resource.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, image)</code>
|
||||
<pre>Returns the specified image resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
image: string, Name of the image resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A disk image resource.
|
||||
"status": "A String", # Status of the image (output only). It will be one of the following READY - after image has been successfully created and is ready for use FAILED - if creating the image fails for some reason PENDING - the image creation is in progress An image can be used to create other resources suck as instances only after the image has been successfully created and the status is set to READY.
|
||||
"kind": "compute#image", # Type of the resource.
|
||||
"description": "A String", # Textual description of the resource; provided by the client when the resource is created.
|
||||
"rawDisk": { # The raw disk image parameters.
|
||||
"containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
|
||||
"source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
|
||||
"sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
|
||||
},
|
||||
"preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
|
||||
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
},
|
||||
"sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(project, body)</code>
|
||||
<pre>Creates an image resource in the specified project using the data included in the request.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A disk image resource.
|
||||
"status": "A String", # Status of the image (output only). It will be one of the following READY - after image has been successfully created and is ready for use FAILED - if creating the image fails for some reason PENDING - the image creation is in progress An image can be used to create other resources suck as instances only after the image has been successfully created and the status is set to READY.
|
||||
"kind": "compute#image", # Type of the resource.
|
||||
"description": "A String", # Textual description of the resource; provided by the client when the resource is created.
|
||||
"rawDisk": { # The raw disk image parameters.
|
||||
"containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
|
||||
"source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
|
||||
"sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
|
||||
},
|
||||
"preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
|
||||
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
},
|
||||
"sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of image resources available to the specified project.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of disk image resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The disk image resources.
|
||||
{ # A disk image resource.
|
||||
"status": "A String", # Status of the image (output only). It will be one of the following READY - after image has been successfully created and is ready for use FAILED - if creating the image fails for some reason PENDING - the image creation is in progress An image can be used to create other resources suck as instances only after the image has been successfully created and the status is set to READY.
|
||||
"kind": "compute#image", # Type of the resource.
|
||||
"description": "A String", # Textual description of the resource; provided by the client when the resource is created.
|
||||
"rawDisk": { # The raw disk image parameters.
|
||||
"containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
|
||||
"source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
|
||||
"sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
|
||||
},
|
||||
"preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
|
||||
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
},
|
||||
"sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
},
|
||||
],
|
||||
"kind": "compute#imageList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
1072
docs/dyn/compute_v1beta15.instances.html
Normal file
1072
docs/dyn/compute_v1beta15.instances.html
Normal file
File diff suppressed because it is too large
Load Diff
167
docs/dyn/compute_v1beta15.kernels.html
Normal file
167
docs/dyn/compute_v1beta15.kernels.html
Normal file
@@ -0,0 +1,167 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.kernels.html">kernels</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, kernel)</a></code></p>
|
||||
<p class="firstline">Returns the specified kernel resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of kernel resources available to the specified project.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, kernel)</code>
|
||||
<pre>Returns the specified kernel resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
kernel: string, Name of the kernel resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A kernel resource.
|
||||
"kind": "compute#kernel", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource.
|
||||
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this kernel.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
},
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of kernel resources available to the specified project.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of kernel resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The kernel resources.
|
||||
{ # A kernel resource.
|
||||
"kind": "compute#kernel", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource.
|
||||
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this kernel.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
},
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource.
|
||||
},
|
||||
],
|
||||
"kind": "compute#kernelList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
274
docs/dyn/compute_v1beta15.machineTypes.html
Normal file
274
docs/dyn/compute_v1beta15.machineTypes.html
Normal file
@@ -0,0 +1,274 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.machineTypes.html">machineTypes</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of machine type resources grouped by scope.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, zone, machineType)</a></code></p>
|
||||
<p class="firstline">Returns the specified machine type resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of machine type resources available to the specified project.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of machine type resources grouped by scope.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": { # A map of scoped machine type lists.
|
||||
"a_key": { # Name of the scope containing this set of machine types.
|
||||
"machineTypes": [ # List of machine types contained in this scope.
|
||||
{ # A machine type resource.
|
||||
"guestCpus": 42, # Count of CPUs exposed to the instance.
|
||||
"imageSpaceGb": 42, # Space allotted for the image, defined in GB.
|
||||
"kind": "compute#machineType", # Type of the resource.
|
||||
"maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
|
||||
"description": "A String", # An optional textual description of the resource.
|
||||
"zone": "A String", # Url of the zone where the machine type resides (output only).
|
||||
"maximumPersistentDisks": 42, # Maximum persistent disks allowed.
|
||||
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this machine type.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
},
|
||||
"memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
|
||||
"scratchDisks": [ # List of extended scratch disks assigned to the instance.
|
||||
{
|
||||
"diskGb": 42, # Size of the scratch disk, defined in GB.
|
||||
},
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource.
|
||||
},
|
||||
],
|
||||
"warning": { # Informational warning which replaces the list of machine types when the list is empty.
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
"kind": "compute#machineTypeAggregatedList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</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="get">get(project, zone, machineType)</code>
|
||||
<pre>Returns the specified machine type resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
zone: string, Name of the zone scoping this request. (required)
|
||||
machineType: string, Name of the machine type resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A machine type resource.
|
||||
"guestCpus": 42, # Count of CPUs exposed to the instance.
|
||||
"imageSpaceGb": 42, # Space allotted for the image, defined in GB.
|
||||
"kind": "compute#machineType", # Type of the resource.
|
||||
"maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
|
||||
"description": "A String", # An optional textual description of the resource.
|
||||
"zone": "A String", # Url of the zone where the machine type resides (output only).
|
||||
"maximumPersistentDisks": 42, # Maximum persistent disks allowed.
|
||||
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this machine type.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
},
|
||||
"memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
|
||||
"scratchDisks": [ # List of extended scratch disks assigned to the instance.
|
||||
{
|
||||
"diskGb": 42, # Size of the scratch disk, defined in GB.
|
||||
},
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of machine type resources available to the specified project.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
zone: string, Name of the zone scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of machine type resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The machine type resources.
|
||||
{ # A machine type resource.
|
||||
"guestCpus": 42, # Count of CPUs exposed to the instance.
|
||||
"imageSpaceGb": 42, # Space allotted for the image, defined in GB.
|
||||
"kind": "compute#machineType", # Type of the resource.
|
||||
"maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
|
||||
"description": "A String", # An optional textual description of the resource.
|
||||
"zone": "A String", # Url of the zone where the machine type resides (output only).
|
||||
"maximumPersistentDisks": 42, # Maximum persistent disks allowed.
|
||||
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this machine type.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
},
|
||||
"memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
|
||||
"scratchDisks": [ # List of extended scratch disks assigned to the instance.
|
||||
{
|
||||
"diskGb": 42, # Size of the scratch disk, defined in GB.
|
||||
},
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource.
|
||||
},
|
||||
],
|
||||
"kind": "compute#machineTypeList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
288
docs/dyn/compute_v1beta15.networks.html
Normal file
288
docs/dyn/compute_v1beta15.networks.html
Normal file
@@ -0,0 +1,288 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.networks.html">networks</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(project, network)</a></code></p>
|
||||
<p class="firstline">Deletes the specified network resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, network)</a></code></p>
|
||||
<p class="firstline">Returns the specified network resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(project, body)</a></code></p>
|
||||
<p class="firstline">Creates a network resource in the specified project using the data included in the request.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of network resources available to the specified project.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(project, network)</code>
|
||||
<pre>Deletes the specified network resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
network: string, Name of the network resource to delete. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, network)</code>
|
||||
<pre>Returns the specified network resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
network: string, Name of the network resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A network resource.
|
||||
"kind": "compute#network", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
|
||||
"gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(project, body)</code>
|
||||
<pre>Creates a network resource in the specified project using the data included in the request.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A network resource.
|
||||
"kind": "compute#network", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
|
||||
"gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of network resources available to the specified project.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of network resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The network resources.
|
||||
{ # A network resource.
|
||||
"kind": "compute#network", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
|
||||
"gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
},
|
||||
],
|
||||
"kind": "compute#networkList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
190
docs/dyn/compute_v1beta15.projects.html
Normal file
190
docs/dyn/compute_v1beta15.projects.html
Normal file
@@ -0,0 +1,190 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.projects.html">projects</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project)</a></code></p>
|
||||
<p class="firstline">Returns the specified project resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#setCommonInstanceMetadata">setCommonInstanceMetadata(project, body)</a></code></p>
|
||||
<p class="firstline">Sets metadata common to all instances within the specified project using the data included in the request.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project)</code>
|
||||
<pre>Returns the specified project resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project resource to retrieve. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A project resource. Projects can be created only in the APIs Console. Unless marked otherwise, values can only be modified in the console.
|
||||
"kind": "compute#project", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource.
|
||||
"commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project.
|
||||
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
|
||||
{
|
||||
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
|
||||
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
|
||||
},
|
||||
],
|
||||
"kind": "compute#metadata", # Type of the resource.
|
||||
"fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
|
||||
},
|
||||
"quotas": [ # Quotas assigned to this project.
|
||||
{ # A quotas entry.
|
||||
"usage": 3.14, # Current usage of this metric.
|
||||
"metric": "A String", # Name of the quota metric.
|
||||
"limit": 3.14, # Quota limit for this metric.
|
||||
},
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="setCommonInstanceMetadata">setCommonInstanceMetadata(project, body)</code>
|
||||
<pre>Sets metadata common to all instances within the specified project using the data included in the request.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # A metadata key/value entry.
|
||||
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
|
||||
{
|
||||
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
|
||||
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
|
||||
},
|
||||
],
|
||||
"kind": "compute#metadata", # Type of the resource.
|
||||
"fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
239
docs/dyn/compute_v1beta15.regionOperations.html
Normal file
239
docs/dyn/compute_v1beta15.regionOperations.html
Normal file
@@ -0,0 +1,239 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.regionOperations.html">regionOperations</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(project, region, operation)</a></code></p>
|
||||
<p class="firstline">Deletes the specified region-specific operation resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, region, operation)</a></code></p>
|
||||
<p class="firstline">Retrieves the specified region-specific operation resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of operation resources contained within the specified region.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(project, region, operation)</code>
|
||||
<pre>Deletes the specified region-specific operation resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
region: string, Name of the region scoping this request. (required)
|
||||
operation: string, Name of the operation resource to delete. (required)
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, region, operation)</code>
|
||||
<pre>Retrieves the specified region-specific operation resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
region: string, Name of the zone scoping this request. (required)
|
||||
operation: string, Name of the operation resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of operation resources contained within the specified region.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
region: string, Name of the region scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of operation resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The operation resources.
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
},
|
||||
],
|
||||
"kind": "compute#operationList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
189
docs/dyn/compute_v1beta15.regions.html
Normal file
189
docs/dyn/compute_v1beta15.regions.html
Normal file
@@ -0,0 +1,189 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.regions.html">regions</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, region)</a></code></p>
|
||||
<p class="firstline">Returns the specified region resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of region resources available to the specified project.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, region)</code>
|
||||
<pre>Returns the specified region resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
region: string, Name of the region resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Region resource.
|
||||
"status": "A String", # Status of the region, "UP" or "DOWN".
|
||||
"kind": "compute#region", # Type of the resource.
|
||||
"description": "A String", # Textual description of the resource.
|
||||
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this region.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
},
|
||||
"quotas": [ # Quotas assigned to this region.
|
||||
{ # A quotas entry.
|
||||
"usage": 3.14, # Current usage of this metric.
|
||||
"metric": "A String", # Name of the quota metric.
|
||||
"limit": 3.14, # Quota limit for this metric.
|
||||
},
|
||||
],
|
||||
"zones": [ # A list of zones homed in this region, in the form of resource URLs.
|
||||
"A String",
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of region resources available to the specified project.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of region resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The region resources.
|
||||
{ # Region resource.
|
||||
"status": "A String", # Status of the region, "UP" or "DOWN".
|
||||
"kind": "compute#region", # Type of the resource.
|
||||
"description": "A String", # Textual description of the resource.
|
||||
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this region.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
},
|
||||
"quotas": [ # Quotas assigned to this region.
|
||||
{ # A quotas entry.
|
||||
"usage": 3.14, # Current usage of this metric.
|
||||
"metric": "A String", # Name of the quota metric.
|
||||
"limit": 3.14, # Quota limit for this metric.
|
||||
},
|
||||
],
|
||||
"zones": [ # A list of zones homed in this region, in the form of resource URLs.
|
||||
"A String",
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource.
|
||||
},
|
||||
],
|
||||
"kind": "compute#regionList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
348
docs/dyn/compute_v1beta15.routes.html
Normal file
348
docs/dyn/compute_v1beta15.routes.html
Normal file
@@ -0,0 +1,348 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.routes.html">routes</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(project, route)</a></code></p>
|
||||
<p class="firstline">Deletes the specified route resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, route)</a></code></p>
|
||||
<p class="firstline">Returns the specified route resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(project, body)</a></code></p>
|
||||
<p class="firstline">Creates a route resource in the specified project using the data included in the request.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of route resources available to the specified project.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(project, route)</code>
|
||||
<pre>Deletes the specified route resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
route: string, Name of the route resource to delete. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, route)</code>
|
||||
<pre>Returns the specified route resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
route: string, Name of the route resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with VMs by tag and the set of Routes for a particular VM is called its routing table. For each packet leaving a VM, the system searches that VM's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the next_hop field of the winning Route -- either to another VM destination, a VM gateway or a GCE operated gateway. Packets that do not match any Route in the sending VM's routing table will be dropped.
|
||||
"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets.
|
||||
"priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values.
|
||||
"kind": "compute#route", # Type of the resource.
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
"tags": [ # A list of instance tags to which this route applies.
|
||||
"A String",
|
||||
],
|
||||
"nextHopInstance": "A String", # The URL to an instance that should handle matching packets.
|
||||
"warnings": [ # If potential misconfigurations are detected for this route, this field will be populated with warning messages.
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
|
||||
"network": "A String", # URL of the network to which this route is applied; provided by the client when the route is created.
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"destRange": "A String", # Which packets does this route apply to?
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(project, body)</code>
|
||||
<pre>Creates a route resource in the specified project using the data included in the request.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with VMs by tag and the set of Routes for a particular VM is called its routing table. For each packet leaving a VM, the system searches that VM's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the next_hop field of the winning Route -- either to another VM destination, a VM gateway or a GCE operated gateway. Packets that do not match any Route in the sending VM's routing table will be dropped.
|
||||
"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets.
|
||||
"priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values.
|
||||
"kind": "compute#route", # Type of the resource.
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
"tags": [ # A list of instance tags to which this route applies.
|
||||
"A String",
|
||||
],
|
||||
"nextHopInstance": "A String", # The URL to an instance that should handle matching packets.
|
||||
"warnings": [ # If potential misconfigurations are detected for this route, this field will be populated with warning messages.
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
|
||||
"network": "A String", # URL of the network to which this route is applied; provided by the client when the route is created.
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"destRange": "A String", # Which packets does this route apply to?
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of route resources available to the specified project.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of route resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The route resources.
|
||||
{ # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with VMs by tag and the set of Routes for a particular VM is called its routing table. For each packet leaving a VM, the system searches that VM's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the next_hop field of the winning Route -- either to another VM destination, a VM gateway or a GCE operated gateway. Packets that do not match any Route in the sending VM's routing table will be dropped.
|
||||
"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets.
|
||||
"priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values.
|
||||
"kind": "compute#route", # Type of the resource.
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
"tags": [ # A list of instance tags to which this route applies.
|
||||
"A String",
|
||||
],
|
||||
"nextHopInstance": "A String", # The URL to an instance that should handle matching packets.
|
||||
"warnings": [ # If potential misconfigurations are detected for this route, this field will be populated with warning messages.
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
|
||||
"network": "A String", # URL of the network to which this route is applied; provided by the client when the route is created.
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"destRange": "A String", # Which packets does this route apply to?
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
},
|
||||
],
|
||||
"kind": "compute#routeList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
220
docs/dyn/compute_v1beta15.snapshots.html
Normal file
220
docs/dyn/compute_v1beta15.snapshots.html
Normal file
@@ -0,0 +1,220 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.snapshots.html">snapshots</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(project, snapshot)</a></code></p>
|
||||
<p class="firstline">Deletes the specified persistent disk snapshot resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, snapshot)</a></code></p>
|
||||
<p class="firstline">Returns the specified persistent disk snapshot resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of persistent disk snapshot resources contained within the specified project.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(project, snapshot)</code>
|
||||
<pre>Deletes the specified persistent disk snapshot resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
snapshot: string, Name of the persistent disk snapshot resource to delete. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, snapshot)</code>
|
||||
<pre>Returns the specified persistent disk snapshot resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
snapshot: string, Name of the persistent disk snapshot resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A persistent disk snapshot resource.
|
||||
"status": "A String", # The status of the persistent disk snapshot (output only).
|
||||
"kind": "compute#snapshot", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created (output only).
|
||||
"sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
|
||||
"diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of persistent disk snapshot resources contained within the specified project.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of persistent disk snapshot resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The persistent snapshot resources.
|
||||
{ # A persistent disk snapshot resource.
|
||||
"status": "A String", # The status of the persistent disk snapshot (output only).
|
||||
"kind": "compute#snapshot", # Type of the resource.
|
||||
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
|
||||
"sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created (output only).
|
||||
"sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
|
||||
"diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
|
||||
},
|
||||
],
|
||||
"kind": "compute#snapshotList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
239
docs/dyn/compute_v1beta15.zoneOperations.html
Normal file
239
docs/dyn/compute_v1beta15.zoneOperations.html
Normal file
@@ -0,0 +1,239 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.zoneOperations.html">zoneOperations</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(project, zone, operation)</a></code></p>
|
||||
<p class="firstline">Deletes the specified zone-specific operation resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, zone, operation)</a></code></p>
|
||||
<p class="firstline">Retrieves the specified zone-specific operation resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of operation resources contained within the specified zone.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(project, zone, operation)</code>
|
||||
<pre>Deletes the specified zone-specific operation resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
zone: string, Name of the zone scoping this request. (required)
|
||||
operation: string, Name of the operation resource to delete. (required)
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, zone, operation)</code>
|
||||
<pre>Retrieves the specified zone-specific operation resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
zone: string, Name of the zone scoping this request. (required)
|
||||
operation: string, Name of the operation resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of operation resources contained within the specified zone.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
zone: string, Name of the zone scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of operation resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The operation resources.
|
||||
{ # An operation resource, used to manage asynchronous API requests.
|
||||
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
|
||||
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"zone": "A String", # URL of the zone where the operation resides (output only).
|
||||
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
|
||||
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
|
||||
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
|
||||
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
|
||||
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
|
||||
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
|
||||
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
|
||||
"warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
|
||||
{
|
||||
"message": "A String", # Optional human-readable details for this warning.
|
||||
"code": "A String", # The warning type identifier for this warning.
|
||||
"data": [ # Metadata for this warning in 'key: value' format.
|
||||
{
|
||||
"value": "A String", # A warning data value corresponding to the key.
|
||||
"key": "A String", # A key for the warning data.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
|
||||
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
|
||||
"kind": "compute#operation", # Type of the resource.
|
||||
"name": "A String", # Name of the resource (output only).
|
||||
"region": "A String", # URL of the region where the operation resides (output only).
|
||||
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
|
||||
"errors": [ # The array of errors encountered while processing this operation.
|
||||
{
|
||||
"message": "A String", # An optional, human-readable error message.
|
||||
"code": "A String", # The error type identifier for this error.
|
||||
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
|
||||
},
|
||||
],
|
||||
},
|
||||
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
|
||||
},
|
||||
],
|
||||
"kind": "compute#operationList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
201
docs/dyn/compute_v1beta15.zones.html
Normal file
201
docs/dyn/compute_v1beta15.zones.html
Normal file
@@ -0,0 +1,201 @@
|
||||
<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="compute_v1beta15.html">Compute Engine API</a> . <a href="compute_v1beta15.zones.html">zones</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(project, zone)</a></code></p>
|
||||
<p class="firstline">Returns the specified zone resource.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the list of zone resources available to the specified project.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(project, zone)</code>
|
||||
<pre>Returns the specified zone resource.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
zone: string, Name of the zone resource to return. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A zone resource.
|
||||
"status": "A String", # Status of the zone. "UP" or "DOWN".
|
||||
"kind": "compute#zone", # Type of the resource.
|
||||
"description": "A String", # Textual description of the resource.
|
||||
"maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
|
||||
{
|
||||
"endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
|
||||
"beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
|
||||
"name": "A String", # Name of the maintenance window.
|
||||
"description": "A String", # Textual description of the maintenance window.
|
||||
},
|
||||
],
|
||||
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this zone.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
},
|
||||
"region": "A String", # Full URL reference to the region which hosts the zone (output only).
|
||||
"quotas": [ # Quotas assigned to this zone.
|
||||
{ # A quotas entry.
|
||||
"usage": 3.14, # Current usage of this metric.
|
||||
"metric": "A String", # Name of the quota metric.
|
||||
"limit": 3.14, # Quota limit for this metric.
|
||||
},
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
|
||||
<pre>Retrieves the list of zone resources available to the specified project.
|
||||
|
||||
Args:
|
||||
project: string, Name of the project scoping this request. (required)
|
||||
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
|
||||
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
|
||||
filter: string, Optional. Filter expression for filtering listed resources.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Contains a list of zone resources.
|
||||
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
|
||||
"items": [ # The zone resources.
|
||||
{ # A zone resource.
|
||||
"status": "A String", # Status of the zone. "UP" or "DOWN".
|
||||
"kind": "compute#zone", # Type of the resource.
|
||||
"description": "A String", # Textual description of the resource.
|
||||
"maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
|
||||
{
|
||||
"endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
|
||||
"beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
|
||||
"name": "A String", # Name of the maintenance window.
|
||||
"description": "A String", # Textual description of the maintenance window.
|
||||
},
|
||||
],
|
||||
"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this zone.
|
||||
"deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
|
||||
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
|
||||
"state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
|
||||
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
|
||||
"replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
|
||||
},
|
||||
"region": "A String", # Full URL reference to the region which hosts the zone (output only).
|
||||
"quotas": [ # Quotas assigned to this zone.
|
||||
{ # A quotas entry.
|
||||
"usage": 3.14, # Current usage of this metric.
|
||||
"metric": "A String", # Name of the quota metric.
|
||||
"limit": 3.14, # Quota limit for this metric.
|
||||
},
|
||||
],
|
||||
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for the resource (output only).
|
||||
"name": "A String", # Name of the resource.
|
||||
},
|
||||
],
|
||||
"kind": "compute#zoneList", # Type of resource.
|
||||
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
|
||||
"selfLink": "A String", # Server defined URL for this resource (output only).
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
@@ -112,12 +112,6 @@ Returns:
|
||||
"previousPageToken": "A String", # A token to provide to get the previous page of results.
|
||||
"kind": "coordinate#tokenPagination", # Identifies this object as pagination information.
|
||||
},
|
||||
"pageInfo": { # Page information. # General pagination information.
|
||||
"totalResults": 42, # Number of results available.
|
||||
"kind": "coordinate#pageInfo", # Identifies this object as page information.
|
||||
"resultPerPage": 42, # Number of results per page.
|
||||
"startIndex": 42, # Page start index.
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -78,10 +78,10 @@ h1, h2, h3 {
|
||||
<code><a href="#get">get(teamId, jobId)</a></code></p>
|
||||
<p class="firstline">Retrieves the schedule for a job.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#patch">patch(teamId, jobId, body, allDay=None, startTime=None, endTime=None)</a></code></p>
|
||||
<code><a href="#patch">patch(teamId, jobId, body, allDay=None, startTime=None, duration=None, endTime=None)</a></code></p>
|
||||
<p class="firstline">Replaces the schedule of a job with the provided schedule. This method supports patch semantics.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(teamId, jobId, body, allDay=None, startTime=None, endTime=None)</a></code></p>
|
||||
<code><a href="#update">update(teamId, jobId, body, allDay=None, startTime=None, duration=None, endTime=None)</a></code></p>
|
||||
<p class="firstline">Replaces the schedule of a job with the provided schedule.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
@@ -96,6 +96,7 @@ Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Job schedule.
|
||||
"duration": "A String", # Job duration in milliseconds.
|
||||
"kind": "coordinate#schedule", # Identifies this object as a job schedule.
|
||||
"allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
|
||||
"startTime": "A String", # Scheduled start time in milliseconds since epoch.
|
||||
@@ -104,7 +105,7 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="patch">patch(teamId, jobId, body, allDay=None, startTime=None, endTime=None)</code>
|
||||
<code class="details" id="patch">patch(teamId, jobId, body, allDay=None, startTime=None, duration=None, endTime=None)</code>
|
||||
<pre>Replaces the schedule of a job with the provided schedule. This method supports patch semantics.
|
||||
|
||||
Args:
|
||||
@@ -114,6 +115,7 @@ Args:
|
||||
The object takes the form of:
|
||||
|
||||
{ # Job schedule.
|
||||
"duration": "A String", # Job duration in milliseconds.
|
||||
"kind": "coordinate#schedule", # Identifies this object as a job schedule.
|
||||
"allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
|
||||
"startTime": "A String", # Scheduled start time in milliseconds since epoch.
|
||||
@@ -122,12 +124,14 @@ Args:
|
||||
|
||||
allDay: boolean, Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
|
||||
startTime: string, Scheduled start time in milliseconds since epoch.
|
||||
duration: string, Job duration in milliseconds.
|
||||
endTime: string, Scheduled end time in milliseconds since epoch.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Job schedule.
|
||||
"duration": "A String", # Job duration in milliseconds.
|
||||
"kind": "coordinate#schedule", # Identifies this object as a job schedule.
|
||||
"allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
|
||||
"startTime": "A String", # Scheduled start time in milliseconds since epoch.
|
||||
@@ -136,7 +140,7 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="update">update(teamId, jobId, body, allDay=None, startTime=None, endTime=None)</code>
|
||||
<code class="details" id="update">update(teamId, jobId, body, allDay=None, startTime=None, duration=None, endTime=None)</code>
|
||||
<pre>Replaces the schedule of a job with the provided schedule.
|
||||
|
||||
Args:
|
||||
@@ -146,6 +150,7 @@ Args:
|
||||
The object takes the form of:
|
||||
|
||||
{ # Job schedule.
|
||||
"duration": "A String", # Job duration in milliseconds.
|
||||
"kind": "coordinate#schedule", # Identifies this object as a job schedule.
|
||||
"allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
|
||||
"startTime": "A String", # Scheduled start time in milliseconds since epoch.
|
||||
@@ -154,12 +159,14 @@ Args:
|
||||
|
||||
allDay: boolean, Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
|
||||
startTime: string, Scheduled start time in milliseconds since epoch.
|
||||
duration: string, Job duration in milliseconds.
|
||||
endTime: string, Scheduled end time in milliseconds since epoch.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Job schedule.
|
||||
"duration": "A String", # Job duration in milliseconds.
|
||||
"kind": "coordinate#schedule", # Identifies this object as a job schedule.
|
||||
"allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
|
||||
"startTime": "A String", # Scheduled start time in milliseconds since epoch.
|
||||
|
||||
1212
docs/dyn/datastore_v1beta1.datasets.html
Normal file
1212
docs/dyn/datastore_v1beta1.datasets.html
Normal file
File diff suppressed because it is too large
Load Diff
82
docs/dyn/datastore_v1beta1.html
Normal file
82
docs/dyn/datastore_v1beta1.html
Normal file
@@ -0,0 +1,82 @@
|
||||
<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="datastore_v1beta1.html">Google Cloud Datastore API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="datastore_v1beta1.datasets.html">datasets()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the datasets Resource.</p>
|
||||
|
||||
</body></html>
|
||||
148
docs/dyn/dfareporting_v1_3.dimensionValues.html
Normal file
148
docs/dyn/dfareporting_v1_3.dimensionValues.html
Normal file
@@ -0,0 +1,148 @@
|
||||
<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="dfareporting_v1_3.html">DFA Reporting API</a> . <a href="dfareporting_v1_3.dimensionValues.html">dimensionValues</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#query">query(profileId, body, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">Retrieves list of report dimension values for a list of filters.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#query_next">query_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="query">query(profileId, body, pageToken=None, maxResults=None)</code>
|
||||
<pre>Retrieves list of report dimension values for a list of filters.
|
||||
|
||||
Args:
|
||||
profileId: string, The DFA user profile ID. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # Represents a DimensionValuesRequest.
|
||||
"dimensionName": "A String", # The name of the dimension for which values should be requested.
|
||||
"startDate": "A String", # The start date of the date range for which to retrieve dimension values. A string of the format: "yyyy-MM-dd".
|
||||
"kind": "dfareporting#dimensionValueRequest", # The kind of request this is, in this case dfareporting#dimensionValueRequest.
|
||||
"endDate": "A String", # The end date of the date range for which to retrieve dimension values. A string of the format: "yyyy-MM-dd".
|
||||
"filters": [ # The list of filters by which to filter values. The filters are ANDed.
|
||||
{ # Represents a dimension filter.
|
||||
"dimensionName": "A String", # The name of the dimension to filter.
|
||||
"kind": "dfareporting#dimensionFilter", # The kind of resource this is, in this case dfareporting#dimensionFilter.
|
||||
"value": "A String", # The value of the dimension to filter.
|
||||
},
|
||||
],
|
||||
}
|
||||
|
||||
pageToken: string, The value of the nextToken from the previous result page.
|
||||
maxResults: integer, Maximum number of results to return.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Represents the list of DimensionValue resources.
|
||||
"nextPageToken": "A String", # Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
|
||||
"items": [ # The dimension values returned in this response.
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
"kind": "dfareporting#dimensionValueList", # The kind of list this is, in this case dfareporting#dimensionValueList.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="query_next">query_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
243
docs/dyn/dfareporting_v1_3.files.html
Normal file
243
docs/dyn/dfareporting_v1_3.files.html
Normal file
@@ -0,0 +1,243 @@
|
||||
<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="dfareporting_v1_3.html">DFA Reporting API</a> . <a href="dfareporting_v1_3.files.html">files</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(reportId, fileId)</a></code></p>
|
||||
<p class="firstline">Retrieves a report file by its report ID and file ID.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get_media">get_media(reportId, fileId)</a></code></p>
|
||||
<p class="firstline">Retrieves a report file by its report ID and file ID.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)</a></code></p>
|
||||
<p class="firstline">Lists files for a user profile.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(reportId, fileId)</code>
|
||||
<pre>Retrieves a report file by its report ID and file ID.
|
||||
|
||||
Args:
|
||||
reportId: string, The ID of the report. (required)
|
||||
fileId: string, The ID of the report file. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
|
||||
"status": "A String", # The status of the report file, one of:
|
||||
# - "PROCESSING"
|
||||
# - "REPORT_AVAILABLE"
|
||||
# - "FAILED"
|
||||
# - "CANCELLED"
|
||||
"kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
|
||||
"format": "A String", # The output format of the report. Only available once the file is available.
|
||||
"dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
|
||||
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
|
||||
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
|
||||
# - "TODAY"
|
||||
# - "YESTERDAY"
|
||||
# - "WEEK_TO_DATE"
|
||||
# - "MONTH_TO_DATE"
|
||||
# - "QUARTER_TO_DATE"
|
||||
# - "YEAR_TO_DATE"
|
||||
# - "PREVIOUS_WEEK"
|
||||
# - "PREVIOUS_MONTH"
|
||||
# - "PREVIOUS_QUARTER"
|
||||
# - "PREVIOUS_YEAR"
|
||||
# - "LAST_7_DAYS"
|
||||
# - "LAST_30_DAYS"
|
||||
# - "LAST_90_DAYS"
|
||||
# - "LAST_365_DAYS"
|
||||
# - "LAST_24_MONTHS"
|
||||
},
|
||||
"fileName": "A String", # The file name of the file.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"reportId": "A String", # The ID of the report this file was generated from.
|
||||
"urls": { # The urls where the completed report file can be downloaded.
|
||||
"browserUrl": "A String", # The url for downloading the report data through a browser.
|
||||
"apiUrl": "A String", # The url for downloading the report data through the API.
|
||||
},
|
||||
"lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
|
||||
"id": "A String", # The unique ID of this report file.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get_media">get_media(reportId, fileId)</code>
|
||||
<pre>Retrieves a report file by its report ID and file ID.
|
||||
|
||||
Args:
|
||||
reportId: string, The ID of the report. (required)
|
||||
fileId: string, The ID of the report file. (required)
|
||||
|
||||
Returns:
|
||||
The media object as a string.
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)</code>
|
||||
<pre>Lists files for a user profile.
|
||||
|
||||
Args:
|
||||
profileId: string, The DFA profile ID. (required)
|
||||
pageToken: string, The value of the nextToken from the previous result page.
|
||||
maxResults: integer, Maximum number of results to return.
|
||||
sortOrder: string, Order of sorted results, default is 'DESCENDING'.
|
||||
Allowed values
|
||||
ASCENDING - Ascending order.
|
||||
DESCENDING - Descending order.
|
||||
sortField: string, The field by which to sort the list.
|
||||
Allowed values
|
||||
ID - Sort by file ID.
|
||||
LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
|
||||
scope: string, The scope that defines which results are returned, default is 'MINE'.
|
||||
Allowed values
|
||||
ALL - All files in account.
|
||||
MINE - My files.
|
||||
SHARED_WITH_ME - Files shared with me.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Represents the list of File resources.
|
||||
"nextPageToken": "A String", # Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
|
||||
"items": [ # The files returned in this response.
|
||||
{ # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
|
||||
"status": "A String", # The status of the report file, one of:
|
||||
# - "PROCESSING"
|
||||
# - "REPORT_AVAILABLE"
|
||||
# - "FAILED"
|
||||
# - "CANCELLED"
|
||||
"kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
|
||||
"format": "A String", # The output format of the report. Only available once the file is available.
|
||||
"dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
|
||||
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
|
||||
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
|
||||
# - "TODAY"
|
||||
# - "YESTERDAY"
|
||||
# - "WEEK_TO_DATE"
|
||||
# - "MONTH_TO_DATE"
|
||||
# - "QUARTER_TO_DATE"
|
||||
# - "YEAR_TO_DATE"
|
||||
# - "PREVIOUS_WEEK"
|
||||
# - "PREVIOUS_MONTH"
|
||||
# - "PREVIOUS_QUARTER"
|
||||
# - "PREVIOUS_YEAR"
|
||||
# - "LAST_7_DAYS"
|
||||
# - "LAST_30_DAYS"
|
||||
# - "LAST_90_DAYS"
|
||||
# - "LAST_365_DAYS"
|
||||
# - "LAST_24_MONTHS"
|
||||
},
|
||||
"fileName": "A String", # The file name of the file.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"reportId": "A String", # The ID of the report this file was generated from.
|
||||
"urls": { # The urls where the completed report file can be downloaded.
|
||||
"browserUrl": "A String", # The url for downloading the report data through a browser.
|
||||
"apiUrl": "A String", # The url for downloading the report data through the API.
|
||||
},
|
||||
"lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
|
||||
"id": "A String", # The unique ID of this report file.
|
||||
},
|
||||
],
|
||||
"kind": "dfareporting#fileList", # The kind of list this is, in this case dfareporting#fileList.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
||||
|
||||
</body></html>
|
||||
97
docs/dyn/dfareporting_v1_3.html
Normal file
97
docs/dyn/dfareporting_v1_3.html
Normal file
@@ -0,0 +1,97 @@
|
||||
<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="dfareporting_v1_3.html">DFA Reporting API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="dfareporting_v1_3.dimensionValues.html">dimensionValues()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the dimensionValues Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="dfareporting_v1_3.files.html">files()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the files Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="dfareporting_v1_3.reports.html">reports()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the reports Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="dfareporting_v1_3.userProfiles.html">userProfiles()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the userProfiles Resource.</p>
|
||||
|
||||
</body></html>
|
||||
763
docs/dyn/dfareporting_v1_3.reports.compatibleFields.html
Normal file
763
docs/dyn/dfareporting_v1_3.reports.compatibleFields.html
Normal file
@@ -0,0 +1,763 @@
|
||||
<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="dfareporting_v1_3.html">DFA Reporting API</a> . <a href="dfareporting_v1_3.reports.html">reports</a> . <a href="dfareporting_v1_3.reports.compatibleFields.html">compatibleFields</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#query">query(profileId, body)</a></code></p>
|
||||
<p class="firstline">Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="query">query(profileId, body)</code>
|
||||
<pre>Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.
|
||||
|
||||
Args:
|
||||
profileId: string, The DFA user profile ID. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # Represents a Report resource.
|
||||
"pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
|
||||
"conversionDimensions": [ # The list of conversion dimensions the report should include.
|
||||
{ # Represents a sorted dimension.
|
||||
"kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
|
||||
"name": "A String", # The name of the dimension.
|
||||
"sortOrder": "A String", # An optional sort order for the dimension column, one of:
|
||||
# - "ASCENDING"
|
||||
# - "DESCENDING"
|
||||
},
|
||||
],
|
||||
"metricNames": [ # The list of names of metrics the report should include.
|
||||
"A String",
|
||||
],
|
||||
"dateRange": { # Represents a date range. # The date range this report should be run for.
|
||||
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
|
||||
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
|
||||
# - "TODAY"
|
||||
# - "YESTERDAY"
|
||||
# - "WEEK_TO_DATE"
|
||||
# - "MONTH_TO_DATE"
|
||||
# - "QUARTER_TO_DATE"
|
||||
# - "YEAR_TO_DATE"
|
||||
# - "PREVIOUS_WEEK"
|
||||
# - "PREVIOUS_MONTH"
|
||||
# - "PREVIOUS_QUARTER"
|
||||
# - "PREVIOUS_YEAR"
|
||||
# - "LAST_7_DAYS"
|
||||
# - "LAST_30_DAYS"
|
||||
# - "LAST_90_DAYS"
|
||||
# - "LAST_365_DAYS"
|
||||
# - "LAST_24_MONTHS"
|
||||
},
|
||||
"reportProperties": { # The properties of the report.
|
||||
"clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
|
||||
"pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
|
||||
"impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
|
||||
"includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
|
||||
"includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
|
||||
"maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
|
||||
"includeAttributedIPConversions": True or False, # Deprecated: has no effect.
|
||||
"maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
|
||||
"maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
|
||||
},
|
||||
"perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
|
||||
{ # Represents a sorted dimension.
|
||||
"kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
|
||||
"name": "A String", # The name of the dimension.
|
||||
"sortOrder": "A String", # An optional sort order for the dimension column, one of:
|
||||
# - "ASCENDING"
|
||||
# - "DESCENDING"
|
||||
},
|
||||
],
|
||||
"activityFilters": [ # The list of 'dfa:activity' values to filter on.
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
"customRichMediaEvents": [ # The list of custom rich media events to include.
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
"floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
"customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
|
||||
{ # Represents a sorted dimension.
|
||||
"kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
|
||||
"name": "A String", # The name of the dimension.
|
||||
"sortOrder": "A String", # An optional sort order for the dimension column, one of:
|
||||
# - "ASCENDING"
|
||||
# - "DESCENDING"
|
||||
},
|
||||
],
|
||||
},
|
||||
"kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
|
||||
"subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
|
||||
"name": "A String", # The name of the report.
|
||||
"schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
|
||||
"startDate": "A String", # Start date of date range for which scheduled reports should be run.
|
||||
"runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
|
||||
# - DAY_OF_MONTH
|
||||
# - WEEK_OF_MONTH
|
||||
# Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
|
||||
"every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
|
||||
"expirationDate": "A String", # The expiration date when the scheduled report stops running.
|
||||
"active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
|
||||
"repeats": "A String", # The interval for which the report is repeated, one of:
|
||||
# - "DAILY", also requires field "every" to be set.
|
||||
# - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
|
||||
# - "TWICE_A_MONTH"
|
||||
# - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
|
||||
# - "QUARTERLY"
|
||||
# - "YEARLY"
|
||||
"repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"format": "A String", # The output format of the report, one of:
|
||||
# - "CSV"
|
||||
# - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
|
||||
"ownerProfileId": "A String", # The user profile id of the owner of this report.
|
||||
"reachCriteria": { # The report criteria for a report of type "REACH".
|
||||
"activities": { # Represents an activity group. # Activity group.
|
||||
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
|
||||
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
"metricNames": [ # List of names of floodlight activity metrics.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"dimensions": [ # The list of dimensions the report should include.
|
||||
{ # Represents a sorted dimension.
|
||||
"kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
|
||||
"name": "A String", # The name of the dimension.
|
||||
"sortOrder": "A String", # An optional sort order for the dimension column, one of:
|
||||
# - "ASCENDING"
|
||||
# - "DESCENDING"
|
||||
},
|
||||
],
|
||||
"metricNames": [ # The list of names of metrics the report should include.
|
||||
"A String",
|
||||
],
|
||||
"dateRange": { # Represents a date range. # The date range this report should be run for.
|
||||
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
|
||||
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
|
||||
# - "TODAY"
|
||||
# - "YESTERDAY"
|
||||
# - "WEEK_TO_DATE"
|
||||
# - "MONTH_TO_DATE"
|
||||
# - "QUARTER_TO_DATE"
|
||||
# - "YEAR_TO_DATE"
|
||||
# - "PREVIOUS_WEEK"
|
||||
# - "PREVIOUS_MONTH"
|
||||
# - "PREVIOUS_QUARTER"
|
||||
# - "PREVIOUS_YEAR"
|
||||
# - "LAST_7_DAYS"
|
||||
# - "LAST_30_DAYS"
|
||||
# - "LAST_90_DAYS"
|
||||
# - "LAST_365_DAYS"
|
||||
# - "LAST_24_MONTHS"
|
||||
},
|
||||
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
|
||||
# Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
"reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
|
||||
"A String",
|
||||
],
|
||||
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
|
||||
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
|
||||
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
"floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
|
||||
"dimensions": [ # The list of dimensions the report should include.
|
||||
{ # Represents a sorted dimension.
|
||||
"kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
|
||||
"name": "A String", # The name of the dimension.
|
||||
"sortOrder": "A String", # An optional sort order for the dimension column, one of:
|
||||
# - "ASCENDING"
|
||||
# - "DESCENDING"
|
||||
},
|
||||
],
|
||||
"metricNames": [ # The list of names of metrics the report should include.
|
||||
"A String",
|
||||
],
|
||||
"dateRange": { # Represents a date range. # The date range this report should be run for.
|
||||
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
|
||||
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
|
||||
# - "TODAY"
|
||||
# - "YESTERDAY"
|
||||
# - "WEEK_TO_DATE"
|
||||
# - "MONTH_TO_DATE"
|
||||
# - "QUARTER_TO_DATE"
|
||||
# - "YEAR_TO_DATE"
|
||||
# - "PREVIOUS_WEEK"
|
||||
# - "PREVIOUS_MONTH"
|
||||
# - "PREVIOUS_QUARTER"
|
||||
# - "PREVIOUS_YEAR"
|
||||
# - "LAST_7_DAYS"
|
||||
# - "LAST_30_DAYS"
|
||||
# - "LAST_90_DAYS"
|
||||
# - "LAST_365_DAYS"
|
||||
# - "LAST_24_MONTHS"
|
||||
},
|
||||
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
|
||||
# Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
"floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
"customRichMediaEvents": [ # The list of custom rich media events to include.
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
"reportProperties": { # The properties of the report.
|
||||
"includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
|
||||
"includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
|
||||
"includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
|
||||
},
|
||||
},
|
||||
"activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
|
||||
"dateRange": { # Represents a date range. # The date range this report should be run for.
|
||||
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
|
||||
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
|
||||
# - "TODAY"
|
||||
# - "YESTERDAY"
|
||||
# - "WEEK_TO_DATE"
|
||||
# - "MONTH_TO_DATE"
|
||||
# - "QUARTER_TO_DATE"
|
||||
# - "YEAR_TO_DATE"
|
||||
# - "PREVIOUS_WEEK"
|
||||
# - "PREVIOUS_MONTH"
|
||||
# - "PREVIOUS_QUARTER"
|
||||
# - "PREVIOUS_YEAR"
|
||||
# - "LAST_7_DAYS"
|
||||
# - "LAST_30_DAYS"
|
||||
# - "LAST_90_DAYS"
|
||||
# - "LAST_365_DAYS"
|
||||
# - "LAST_24_MONTHS"
|
||||
},
|
||||
"metricNames": [ # The list of names of metrics the report should include.
|
||||
"A String",
|
||||
],
|
||||
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
|
||||
# Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
|
||||
# A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
"dimensions": [ # The list of dimensions the report should include.
|
||||
{ # Represents a sorted dimension.
|
||||
"kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
|
||||
"name": "A String", # The name of the dimension.
|
||||
"sortOrder": "A String", # An optional sort order for the dimension column, one of:
|
||||
# - "ASCENDING"
|
||||
# - "DESCENDING"
|
||||
},
|
||||
],
|
||||
},
|
||||
"delivery": { # The report's email delivery settings.
|
||||
"message": "A String", # The message to be sent with each email.
|
||||
"emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
|
||||
# - "ATTACHMENT"
|
||||
# - "LINK"
|
||||
"recipients": [ # The list of recipients to which to email the report.
|
||||
{ # Represents a recipient.
|
||||
"kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
|
||||
"deliveryType": "A String", # The delivery type for the recipient, one of:
|
||||
# - "ATTACHMENT"
|
||||
# - "LINK"
|
||||
"email": "A String", # The email address of the recipient.
|
||||
},
|
||||
],
|
||||
"emailOwner": True or False, # Whether the report should be emailed to the report owner.
|
||||
},
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"criteria": { # The report criteria for a report of type "STANDARD".
|
||||
"activities": { # Represents an activity group. # Activity group.
|
||||
"kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
|
||||
"filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
"metricNames": [ # List of names of floodlight activity metrics.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"dimensions": [ # The list of standard dimensions the report should include.
|
||||
{ # Represents a sorted dimension.
|
||||
"kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
|
||||
"name": "A String", # The name of the dimension.
|
||||
"sortOrder": "A String", # An optional sort order for the dimension column, one of:
|
||||
# - "ASCENDING"
|
||||
# - "DESCENDING"
|
||||
},
|
||||
],
|
||||
"metricNames": [ # The list of names of metrics the report should include.
|
||||
"A String",
|
||||
],
|
||||
"dateRange": { # Represents a date range. # The date range for which this report should be run.
|
||||
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
|
||||
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
|
||||
# - "TODAY"
|
||||
# - "YESTERDAY"
|
||||
# - "WEEK_TO_DATE"
|
||||
# - "MONTH_TO_DATE"
|
||||
# - "QUARTER_TO_DATE"
|
||||
# - "YEAR_TO_DATE"
|
||||
# - "PREVIOUS_WEEK"
|
||||
# - "PREVIOUS_MONTH"
|
||||
# - "PREVIOUS_QUARTER"
|
||||
# - "PREVIOUS_YEAR"
|
||||
# - "LAST_7_DAYS"
|
||||
# - "LAST_30_DAYS"
|
||||
# - "LAST_90_DAYS"
|
||||
# - "LAST_365_DAYS"
|
||||
# - "LAST_24_MONTHS"
|
||||
},
|
||||
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
|
||||
# Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
"customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
|
||||
"kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
|
||||
"filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
"id": "A String", # The unique ID identifying this report resource.
|
||||
"lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
|
||||
"fileName": "A String", # The file name used when generating report files for this report.
|
||||
"type": "A String", # The type of the report, one of:
|
||||
# - STANDARD
|
||||
# - REACH
|
||||
# - ACTIVE_GRP
|
||||
# - PATH_TO_CONVERSION
|
||||
# - FLOODLIGHT
|
||||
# - CROSS_DIMENSION_REACH
|
||||
"crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
|
||||
"breakdown": [ # The list of dimensions the report should include.
|
||||
{ # Represents a sorted dimension.
|
||||
"kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
|
||||
"name": "A String", # The name of the dimension.
|
||||
"sortOrder": "A String", # An optional sort order for the dimension column, one of:
|
||||
# - "ASCENDING"
|
||||
# - "DESCENDING"
|
||||
},
|
||||
],
|
||||
"overlapMetricNames": [ # The list of names of overlap metrics the report should include.
|
||||
"A String",
|
||||
],
|
||||
"metricNames": [ # The list of names of metrics the report should include.
|
||||
"A String",
|
||||
],
|
||||
"dateRange": { # Represents a date range. # The date range this report should be run for.
|
||||
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
|
||||
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
||||
"relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
|
||||
# - "TODAY"
|
||||
# - "YESTERDAY"
|
||||
# - "WEEK_TO_DATE"
|
||||
# - "MONTH_TO_DATE"
|
||||
# - "QUARTER_TO_DATE"
|
||||
# - "YEAR_TO_DATE"
|
||||
# - "PREVIOUS_WEEK"
|
||||
# - "PREVIOUS_MONTH"
|
||||
# - "PREVIOUS_QUARTER"
|
||||
# - "PREVIOUS_YEAR"
|
||||
# - "LAST_7_DAYS"
|
||||
# - "LAST_30_DAYS"
|
||||
# - "LAST_90_DAYS"
|
||||
# - "LAST_365_DAYS"
|
||||
# - "LAST_24_MONTHS"
|
||||
},
|
||||
"dimensionFilters": [ # The list of filters on which dimensions are filtered.
|
||||
{ # Represents a DimensionValue resource.
|
||||
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
|
||||
"value": "A String", # The value of the dimension.
|
||||
"dimensionName": "A String", # The name of the dimension.
|
||||
"etag": "A String", # The eTag of this response for caching purposes.
|
||||
"matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
|
||||
# - EXACT (default if not specified)
|
||||
# - CONTAINS
|
||||
# - BEGINS_WITH
|
||||
# - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
|
||||
"id": "A String", # The ID associated with the value if available.
|
||||
},
|
||||
],
|
||||
"pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
|
||||
"dimension": "A String", # The dimension option, one of:
|
||||
# - "ADVERTISER"
|
||||
# - "CAMPAIGN"
|
||||
# - "SITE_BY_ADVERTISER"
|
||||
# - "SITE_BY_CAMPAIGN"
|
||||
},
|
||||
"accountId": "A String", # The account ID to which this report belongs.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Represents a response to the queryCompatibleFields method.
|
||||
"kind": "dfareporting#compatibleFields", # The kind of resource this is, in this case dfareporting#compatibleFields.
|
||||
"reachReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "REACH". # Contains items that are compatible to be selected for a report of type "REACH".
|
||||
"kind": "dfareporting#reachReportCompatibleFields", # The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.
|
||||
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
|
||||
{ # Represents a dimension.
|
||||
"kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
|
||||
"name": "A String", # The dimension name, e.g. dfa:advertiser
|
||||
},
|
||||
],
|
||||
"reachByFrequencyMetrics": [ # Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report.
|
||||
{ # Represents a metric.
|
||||
"kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
|
||||
"name": "A String", # The metric name, e.g. dfa:impressions
|
||||
},
|
||||
],
|
||||
"pivotedActivityMetrics": [ # Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
|
||||
{ # Represents a metric.
|
||||
"kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
|
||||
"name": "A String", # The metric name, e.g. dfa:impressions
|
||||
},
|
||||
],
|
||||
"dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
|
||||
{ # Represents a dimension.
|
||||
"kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
|
||||
"name": "A String", # The dimension name, e.g. dfa:advertiser
|
||||
},
|
||||
],
|
||||
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
|
||||
{ # Represents a metric.
|
||||
"kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
|
||||
"name": "A String", # The metric name, e.g. dfa:impressions
|
||||
},
|
||||
],
|
||||
},
|
||||
"pathToConversionReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". # Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
|
||||
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
|
||||
{ # Represents a metric.
|
||||
"kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
|
||||
"name": "A String", # The metric name, e.g. dfa:impressions
|
||||
},
|
||||
],
|
||||
"perInteractionDimensions": [ # Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report.
|
||||
{ # Represents a dimension.
|
||||
"kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
|
||||
"name": "A String", # The dimension name, e.g. dfa:advertiser
|
||||
},
|
||||
],
|
||||
"kind": "dfareporting#pathToConversionReportCompatibleFields", # The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.
|
||||
"conversionDimensions": [ # Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report.
|
||||
{ # Represents a dimension.
|
||||
"kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
|
||||
"name": "A String", # The dimension name, e.g. dfa:advertiser
|
||||
},
|
||||
],
|
||||
"customFloodlightVariables": [ # Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report.
|
||||
{ # Represents a dimension.
|
||||
"kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
|
||||
"name": "A String", # The dimension name, e.g. dfa:advertiser
|
||||
},
|
||||
],
|
||||
},
|
||||
"crossDimensionReachReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". # Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
|
||||
"breakdown": [ # Dimensions which are compatible to be selected in the "breakdown" section of the report.
|
||||
{ # Represents a dimension.
|
||||
"kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
|
||||
"name": "A String", # The dimension name, e.g. dfa:advertiser
|
||||
},
|
||||
],
|
||||
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
|
||||
{ # Represents a metric.
|
||||
"kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
|
||||
"name": "A String", # The metric name, e.g. dfa:impressions
|
||||
},
|
||||
],
|
||||
"kind": "dfareporting#crossDimensionReachReportCompatibleFields", # The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.
|
||||
"overlapMetrics": [ # Metrics which are compatible to be selected in the "overlapMetricNames" section of the report.
|
||||
{ # Represents a metric.
|
||||
"kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
|
||||
"name": "A String", # The metric name, e.g. dfa:impressions
|
||||
},
|
||||
],
|
||||
"dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
|
||||
{ # Represents a dimension.
|
||||
"kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
|
||||
"name": "A String", # The dimension name, e.g. dfa:advertiser
|
||||
},
|
||||
],
|
||||
},
|
||||
"floodlightReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". # Contains items that are compatible to be selected for a report of type "FLOODLIGHT".
|
||||
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
|
||||
{ # Represents a metric.
|
||||
"kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
|
||||
"name": "A String", # The metric name, e.g. dfa:impressions
|
||||
},
|
||||
],
|
||||
"kind": "dfareporting#floodlightReportCompatibleFields", # The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.
|
||||
"dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
|
||||
{ # Represents a dimension.
|
||||
"kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
|
||||
"name": "A String", # The dimension name, e.g. dfa:advertiser
|
||||
},
|
||||
],
|
||||
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
|
||||
{ # Represents a dimension.
|
||||
"kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
|
||||
"name": "A String", # The dimension name, e.g. dfa:advertiser
|
||||
},
|
||||
],
|
||||
},
|
||||
"reportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "STANDARD". # Contains items that are compatible to be selected for a report of type "STANDARD".
|
||||
"metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
|
||||
{ # Represents a metric.
|
||||
"kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
|
||||
"name": "A String", # The metric name, e.g. dfa:impressions
|
||||
},
|
||||
],
|
||||
"kind": "dfareporting#reportCompatibleFields", # The kind of resource this is, in this case dfareporting#reportCompatibleFields.
|
||||
"pivotedActivityMetrics": [ # Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
|
||||
{ # Represents a metric.
|
||||
"kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
|
||||
"name": "A String", # The metric name, e.g. dfa:impressions
|
||||
},
|
||||
],
|
||||
"dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
|
||||
{ # Represents a dimension.
|
||||
"kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
|
||||
"name": "A String", # The dimension name, e.g. dfa:advertiser
|
||||
},
|
||||
],
|
||||
"dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
|
||||
{ # Represents a dimension.
|
||||
"kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
|
||||
"name": "A String", # The dimension name, e.g. dfa:advertiser
|
||||
},
|
||||
],
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user